ZAP

zap.auto_run

DEPRECATED in version 3.2. Use zap.debug.auto_run instead.

Description

Specify ZentriOS app to run on startup. App must be compiled and downloaded to module external flash.

Note that zap.auto_run is NOT cleared by factory reset. This is by design. The ZAP is THE controller of the system. If you ran a factory reset in the field, and unintentionally cleared zap.auto_run, the device would no longer run the ZAP as intended.

There are ways to clear zap.auto_run manually:

• Force safemode. Assert GPIO0 for 30 seconds, which has the same effect as running the force_safemode command. If you force safemode eight times, the device enters the lowest level safemode and the ZAP does not run automatically. Then you can clear zap.auto_run by setting it to None.
• Reprogram the device. For example, run the device setup sequence using the ZentriOS SDK and IDE.

Arguments

<zap_filename> where:

<zap_filename>: The filename in extended flash, e.g. apps/basic/hello_world.zap

In the case of the NXP-SCCK, use a value of 1 instead of the filename.

Default

None

Properties

• save and reboot to apply change
• lockable: see system.variable_lock

Supported Platforms

• AMW004
• AMW106
• AMW136

Get example

> get za a
apps/external_hello_world-debug.zap

Set example

For Zentri devices:

> set zap.auto_run apps/external_hello_world-debug.zap
ZOS auto-app set
Set OK

For NXP device:

> set zap.auto_run 1
ZOS auto-app set
Set OK

zap.debug.auto_run

Description

Enable/disable ZAP from auto running.

This variable is not saved. When power is removed the variable is reset to its default value.

By default, a ZAP always runs on power up.

The zap.debug.auto_run variable is intended for use only in a debug session, to allow inputting commands to the ZentriOS terminal.

Arguments

1/0 where 1: enable, 0: disable

Default

1

Properties

• takes effect immediately

Supported Platforms

• AMW004
• AMW106
• AMW136

Get example

> get za d a
apps/external_hello_world-debug.zap

Set example

> set zap.debug.auto_run 0
Set OK

zap.debug.enabled

Description

Enable/Disable zap debug. Must be enabled to allow downloading compiled ZentriOS apps to the module.

Arguments

<0/1>

Default

1

Properties

• takes effect immediately

Supported Platforms

• AMW004
• AMW106
• AMW136

Get example

> get zap.debug.enabled
1

Set example

> set za d e 0
Set OK

zap.debug.ignore_settings

Description

This allows manual adjustment of variable settings while debugging a ZentriOS app that loads settings using the API zn_settings_load().

When zap.debug.ignore_settings is set, all calls to zn_settings_load() are ignored. You can then load the ZentriOS app without overwriting test variable settings.

Arguments

<0/1>

Default

0

Properties

• takes effect immediately

Supported Platforms

• AMW004
• AMW106
• AMW136

Get example

> get zap.debug.ignore_settings
0

Set example

> set zap.debug.ignore_settings 1
0
Set OK

zap.info

Description

View a hash identifying the Native API version and the running ZentriOS app.

If no ZAP is running, output shows running: none

Arguments

-

Default

-

Supported Platforms

• AMW004
• AMW106
• AMW136

Get example

get zap.info
api: 0x4C0A17FD
running: hello_world.zap

Note that running shows none only if no ZAP is programmed (e.g. directly after SDK Setup Device), or if zap.debug.auto_run is true:

> get zap
zap.auto_run: 1
zap.debug.auto_run: 1
zap.debug.enabled: 1
zap.debug.ignore_settings: 0
zap.info:
api: 0x8741244D
running: none