TCP Server

tcp.server.auto_start

Abbreviationtc s a
Accessget/set

Description

Enable/disable TCP server auto-start on bootup.

Arguments

<0/off/false/1/on/true>

Default

0

Properties

Supported Platforms

Get example

> get tc s a
R000003
0

Set example

> set tc s a true
R000008
Set OK

tcp.server.connected_gpio

Abbreviationtc s c
Accessget/set

Description

The GPIO used to indicate whether a client is connected to the TCP server.

See also system.oob.gpio.

Arguments

<[GPIO#]/[-1]>

Default

-1

Properties

Supported Platforms

Get example

> get tc s c
R000004
-1

Set example

> set tc s c 12
R000008
Set OK

tcp.server.data_gpio

Abbreviationtc s d
Accessget/set

Description

The GPIO used to indicate whether a connected client has data available to read.
Note: Disable by setting to -1.

See also system.oob.gpio.

Arguments

<GPIO#>

Default

-1

Properties

Supported Platforms

Get example

> get tc s d
R000004
-1

Set example

> set tc s d 13
R000008
Set OK

tcp.server.idle_timeout

Abbreviationtc s t
Accessget/set

Description

Maximum client idle time in seconds before the client is automatically disconnected.

Setting tcp.server.idle_timeout to 0 turns off timeout completely: TCP server does not disconnect idle clients.

Arguments

<seconds>

Default

60

Properties

Supported Platforms

Get example

> get tc s t
R000004
60

Set example

> set tc s t 30
R000008
Set OK

tcp.server.port

Abbreviationtc s p
Accessget/set

Description

TCP server port to listen on

Arguments

<port>

Default

3000

Properties

Supported Platforms

Get example

> get tc s p
R000006
3000

Set example

> set tc s p 3001
R000008
Set OK