- v4.1 - Gecko OS API Documentation Silicon Labs

mDNS

mdns.enabled

Abbreviation

md e

Access

get/set

Description

Enable the mDNS daemon (i.e. background process). The process is started when the configured interface is brought up (see mdns.interface ). If the network interface is already up when mDNS is enabled, bring the network interface down and up again to start mDNS (see network_down , network_up ). See Networking and Security, Network Discovery .

Note : When mDNS is enabled, .local domains are first attempted to be resolved using mDNS. If the attempt fails, standard DNS is then attempted.

Arguments

1|true|on/0|false|off

Default

1

Platforms

WGM160P

Properties

network_restart to apply change

Gecko OS Plugin

protocols.bonjour

Set example

> set mdns.enabled 1
Set OK

Get example

> get md e
1

mdns.interface

Abbreviation

md i

Access

get/set

Description

The network interface on which the mDNS daemon runs. See Networking and Security, Network Discovery .

Arguments

default/softap/wlan

Default

default

Platforms

WGM160P

Properties

network_restart to apply change

Gecko OS Plugin

protocols.bonjour

Set example

> set mdns.interface wlan
Set OK

Get example

> get md i
wlan

mdns.name

Abbreviation

md n

Access

get/set

Description

The mDNS domain name of the module.

Note :

.local is appended to the name. See Networking and Security, Network Discovery .
If the specified name conflicts with a pre-existing mDNS name, a number is automatically appended to the name, e.g. mymodule-2.local .

Arguments

<name>

Only valid domain characters are supported: a-z, A-Z, 0-9, -, ..
If the # character is the last character in the name, then it is replaced by the last three hex characters of the module's MAC address, e.g. if device MAC address is 4C:55:CC:10:26:05 , and mdns.name is gecko_os-# , then name becomes: gecko_os-605 .

Default

gecko_os-#

Platforms

WGM160P

Properties

network_restart to apply change

Gecko OS Plugin

protocols.bonjour

Set example

> set mdns.name MyDomain_#
Set OK

Get example

> get md n
MyDomain_#

mdns.service

Abbreviation

md s

Access

get/set

Description

Advertise a module server via mDNS. See Networking and Security, Network Discovery .

The corresponding server must be enabled and configured to auto-start before the service is advertised via mDNS.

Arguments

Set Syntax

<server name> [<name> [<txt> [<service type>] ] ]

where:

`<server name>`	The name of a Gecko OS server protocol. The following servers are available:
	`http` - HTTP server
	`tcp` - TCP server
	`udp` - UDP server
	`remote_terminal` - Remote Terminal server
`<name>`	An additional name/description of the service. For example: `Sensor HTTP Server` . To disable advertising of an mDNS service, set the `<name>` argument to `-1` or `disabled` . To set the name to the default value specified in mdns.name , set the `<name>` argument to `default` .
`<txt>`	Additional configuration settings for the service. This is a Bonjour style TXT Record, consisting of a string of = pairs, separated by an ASCII '.' character (code 0x2E). e.g. `set mdns.service http "Test Server" "record1=on.record2=off.another=21"`
`<service type>`	The service registration type. (Note: .local is appended to the end) By default, the following server/service type is used:
	HTTP server - `_http._tcp.local`
	TCP server - `_gecko_os._tcp.local`
	UDP server - `_gecko_os._udp.local`
	Remote Terminal server - _telnet._tcp.local

See:

mdns.name

Get Syntax

<server name> where: <server name> is one of:

http
tcp
udp
remote_terminal
all - list all servers

The response lists the attributes as follows: "<name>" "<txt>" <type> e.g.

> get md s http
"Test Server" "record1=on.record2=off.another=21" _http._tcp.local

If all is specified to list status of all servers, the response lists the servers and attributes as follows:

<server name> - <name>.type <txt>
...

e.g.

> get md s all
http - Test Server._http._tcp.local record1=on.record2=off.another=21
tcp - my_tcp_server._gecko_os._tcp.local
udp - Disabled
remote_terminal - Disabled

Default

None

Platforms

WGM160P

Properties

network_restart to apply change

Gecko OS Plugin

protocols.bonjour

Set example

Advertise tcp service as my_tcp_server

> set md s tcp my_tcp_server
Set OK
> get md s all
http - Disabled
tcp - my_tcp_server._gecko_os._tcp.local
udp - Disabled
remote_terminal - Disabled

Disable advertising of tcp service

> set md s tcp -1
Set OK
> set md s tcp -1
Set OK
> get md s all
http - Disabled
tcp - Disabled
udp - Disabled
remote_terminal - Disabled

Get example

> get md s tcp
"my_tcp_server" "" _gecko_os._tcp.local

mdns.ttl

Abbreviation

md t

Access

get/set

Description

Sets the timeout of the module's mDNS response in seconds: the "Time-to-Live" of a mDNS response from the module. This is essentially a timeout of the validity of a mDNS record. Once expired, a remote client will reprobe the module for an updated response. See Networking and Security, Network Discovery .

Arguments

<seconds>

where:

<seconds> is in the range 1 - 65535 .

Default

300

Platforms

WGM160P

Properties

network_restart to apply change

Gecko OS Plugin

protocols.bonjour

Set example

> set mdns.ttl 1000

Get example

> get mdns.ttl
1000