Bus

bus.mode

Abbreviation

bu m

Access

get/set

Description

The serial bus mode.

Arguments

<command/stream>

Default

command

Properties

• save and reboot to apply change
• available in Safe Mode
• preserved by NVM Backup

Supported Platforms

• AMW007
• AMW037

Get example

> get bu m
R000009
command

Set example

> set bu m command
R000008
Set OK

bus.stream.cmd_gpio

Abbreviation

bu s g

Access

get/set

Description

The GPIO used to force the module into command mode (from stream mode). A value of -1 disables this feature.

Arguments

<[GPIO#]/[-1]>

Default

0

Properties

• save and reboot to apply change

Supported Platforms

• AMW007
• AMW037

Get example

> get bu s g
R000003
0

Set example

> set bu s g 6
R000008
Set OK

bus.stream.cmd_seq

Abbreviation

bu s s

Access

get/set

Description

Break-in sequence for stream mode. After 3 seconds of inactivity on the serial interface, sending the break-in sequence changes stream mode to command mode; send 'exit' to return to stream mode.

Note : The length of the break-in sequence affects the allowed minimum value of bus.stream.flush_count .

This feature may be disabled with the following command:

set bus.stream.cmd_seq ""

When disabled, the break-in sequence is disabled. This allows for binary data streams or for any streams which may be interpreted incorrectly as the break-in sequence.

Note : If this feature is disabled it's strongly recommended to enable bus.stream.cmd_gpio and/or another remote command feature, such as the remote terminal or the Web App .

Otherwise the Gecko OS command console will be inaccessible until the module is factory reset.

Arguments

<1-15 characters>

Default

$$$

Properties

• save and reboot to apply change

Supported Platforms

• AMW007
• AMW037

Get example

> get bu s s
R000005
$$$

Set example

> set bu s s ###
R000008
Set OK

bus.stream.flush_count

Abbreviation

bu s c

Access

get/set

Description

Number of bytes received on the serial bus before flushing to the network stream.

Arguments

<count> where <count> can range from minimum value to maximum value :

• minimum value : MAX(16, len(bus.stream.cmd_seq)*2)
  i.e. the minimum value is the maximum of 16 and 2 x the length of the bus.stream.cmd_seq variable
  For example, if bus.stream.cmd_seq is the default $$$ , its length is 3, so minimum value is the maximum of 16 and 2*3 = 16.
• maximum value : 1460

Default

1460

Properties

• save and reboot to apply change

Supported Platforms

• AMW007
• AMW037

Get example

> get bu s c
R000006
1460

Set example

> set bu s c 1450
R000008
Set OK

bus.stream.flush_time

Abbreviation

bu s t

Access

get/set

Description

Timeout in milliseconds before bytes are automatically flushed to the network stream.

If set to 0, automatic flush is disabled.

To achieve optimal throughput, set flush time to 0. Gecko OS transfers data with 'Zero Copy'. i.e. a data packet is directly transferred from the bus to network or network to bus.

Arguments

<0-65535>

Default

50

Properties

• save and reboot to apply change

Supported Platforms

• AMW007
• AMW037

Get example

> get bu s t
R000004
20

Set example

> set bu s t 10
R000008
Set OK

bus.stream.flush_time_reset

Abbreviation

bu s r

Access

get/set

Description

Flag whether to reset the flush timer if data is received before the flush timeout expires. When this variable is set and data is streaming, data is flushed only when the buffer is full. This allows for efficient use of the packet buffer and prevents packet fragmentation. When the variable is reset, the buffer is flushed at intervals of bus.stream.flush_time and also when the buffer is full. This allows data to be sent at consistent intervals.

Arguments

<1/0>

Default

0

Properties

• save and reboot to apply change

Supported Platforms

• AMW007
• AMW037

Get example

> get bus.stream.flush_time_reset
0

Set example

> set bus.stream.flush_time_reset 1
Set OK