Integration Guide

SMK900 Integration Guide Revision 4
Constant name
Bit
positio
n
Bit-mask
value
Description
SERIAL_bm
0
0x01
Activate virtual machine when a serial command for VM Exec
has been received locally (see section 5 for details) via the
UART communication bus. In this case, the VM command is
executed on the spot when the serial command is received.
Note that if the VM is executed during an active broadcast
cycle, the virtual machine engine will always yield to the mesh
protocol controller software when the latter needs to execute
timing-critical operations for synchronizing the transceiver
with its mesh network, as for any local serial commands (see
section 3.0 for details).
AIRCMD_bm
1
0x02
Activate virtual machine in a node when an air command for
VM Exec (i.e. command wrapped with an Air Cmd. Wrapper)
from a gateway has been received via a gateway broadcast out
phase (see section 5 for details). In this case, the VM execution
command is executed at the end of the broadcast cycle in
which the air command was received, like any other air
command requests. Note that LEAVEBROADCAST_bm event
marker will be activated before said VM will be executed, if
that event marker is enabled.
BOOTUP_bm
2
0x04
Activate virtual machine when the main boot sequence and
configuration initialization of the transceiver finished
executing.
ENTERSEEKMODE_bm
3
0x08
Activate virtual machine when a node goes into seek mode (i.e.
searches for an existing mesh network to latch itself onto).
LEAVESEEKMODE_bm
4
0x10
Activate virtual machine when a node leaves seek mode (i.e.
just found an existing mesh network to latch itself onto).
ENTERBROADCAST_bm
5
0x20
Activate virtual machine when a transceiver (gateway or node)
starts a broadcast cycle (i.e. leaves sleep/idle state in between
broadcast cycles).
LEAVEBROADCAST_bm
6
0x40
Activate virtual machine when a transceiver (gateway or node)
broadcast cycle just ended (i.e. about to go to sleep). Note that
this event, if enabled, will be always triggered before any
pending VM execution request via air command (see above,
AIRCMD_bm) will be executed.
ENABLEVMFLASHOP_bm
7
0x80
Enable VM flash operations. This needs to be enabled for VM
programming operations to be available, and thus acts as a
safety lock flag.
sniffFlagsMask
flags which, when activated, enable sniffing of some types of packets, either from a gateway to
another node, or vice versa. The concept of sniffing is only relevant when using UART command
mode, because transparent mode acts as a dumb point-to-multipoint serial link between all the
transceivers. Moreover, this mode is only relevant for air commands when considering packets
outgoing from a gateway to nodes, because only this mode uses automatic packet filtering at the
destination transceiver site using the requested MAC address given by the gateway. Indeed, all
regular long packet transmissions out in command mode are considered as being whole network
broadcasts, and are received by default by all node transceivers in the mesh network. Here is a
description table of the relevant flags:
Constant name
Bit
position
Bit-mask
value
Description
BROADCASTIN_bm
0
0x01
Enable node sniffing of broadcast in phase messages from
other nodes to gateway. All broadcast in that was sent in
command mode by another node, be it an air command or a
regular packet transmission, will be read by the sniffing
transceiver when this mode is activated.
BROADCASTOUT_AIR_bm
1
0x02
Enable node sniffing of broadcast out air commands to
specific MAC addresses that do not match address of said
sniffer node. Note that this mode only applies for air
commands sent from a gateway out.
36