UDP Client

udp.client.auto_interface

Abbreviation

ud c i

Access

get/set

Description

Interface to auto-start UDP client connection.

Arguments

default

Default

<default/wlan/softap>

Platforms

• WGM160P

Properties

• network_restart to apply change

Gecko OS Plugin

• protocols.udp.client

Get example

> get udp.client.auto_interface
default

Set example

> set ud c i wlan
Set OK

udp.client.auto_retry

Abbreviation

ud c r

Access

get/set

Description

Enable automatic reconnection if udp.client.auto_start fails.

When enabled, Gecko OS attempts to reconnect every 1.0s until either the network goes down or it successfully connects.

UDP is a connectionless protocol so udp.client.auto_start fails only if udp.client.auto_start cannot resolve the udp.client.remote_host DNS domain. If udp.client.remote_host specifies an IP address, failure to connect is not detected.

Arguments

1|true|on/0|false|off

where

• 0 or false or off : auto retry disabled
• 1 or true or on : auto retry enabled

Default

0

Platforms

• WGM160P

Properties

• takes effect immediately

Gecko OS Plugin

• protocols.udp.client

Get example

> get udp.client.auto_retry
0

Set example

> set ud c r 1
Set OK

udp.client.auto_start

Abbreviation

ud c a

Access

get/set

Description

Enable/disable UDP client auto-start feature. If enabled, UDP client automatically connects to remote server when interface is brought up.

Arguments

1|true|on/0|false|off

where

• 0 or false or off : auto retry disabled
• 1 or true or on : auto retry enabled

Default

0

Platforms

• WGM160P

Properties

• network_restart to apply change

Gecko OS Plugin

• protocols.udp.client

Get example

> get udp.client.auto_start
0

Set example

> set ud c a 1
Set OK

udp.client.local_port

Abbreviation

ud c l

Access

get/set

Description

Local udp server port.

Arguments

<port>

Default

0

Platforms

• WGM160P

Gecko OS Plugin

• protocols.udp.client

Get example

> get udp.client.local_port
0

Set example

> set ud c l 5000
Set OK

udp.client.remote_host

Abbreviation

ud c h

Access

get/set

Description

Domain or IP address of remote udp server to auto connect.

Arguments

<domain/ip address>

Default

None

Platforms

• WGM160P

Properties

• takes effect immediately

Gecko OS Plugin

• protocols.udp.client

Get example

> get udp.client.remote_host
mydomain.com

Set example

> set ud c h mydomain.com
Set OK

udp.client.remote_port

Abbreviation

ud c p

Access

get/set

Description

Port of remote UDP server to auto connect.

Arguments

<port>

Default

3000

Platforms

• WGM160P

Properties

• takes effect immediately

Gecko OS Plugin

• protocols.udp.client

Get example

> get udp.client.remote_port

Set example

> set ud c p 5000
Set OK