snaptoolbelt - read the docs · 2019. 4. 2. · mode, snapstick0for ss200s in usb mode, or a device...

SNAPtoolbeltRelease

May 26, 2016

Contents

1 Getting Started 3

2 Command Reference 9

3 License 45

i

SNAPtoolbelt, Release

SNAPtoolbelt is a collection of scriptable command line tools for interacting with SNAP nodes and networks.

This manual assumes you have some knowledge of SNAP systems. If you aren’t familiar with SNAP, please consultthe SNAP Primer and associated documentation.

Contents 1


2 Contents

CHAPTER 1

Getting Started

1.1 Installation

1.1.1 Requirements

Be sure to load these requirements before installing the package:

• Python 2.6 or 2.7

• pip 8.1 or later

• wheel 0.29 or later

• virtualenv 15.0 or later

To ensure that pip, wheel, and virtualenv are installed and up-to-date:

pip install --upgrade pip wheel virtualenv

1.1.2 Setup a Virtual Environment (Recommended)

Using a virtualenv keeps the SNAPtoolbelt’s dependencies from conflicting with your own project dependencies. Thedirections to set up a virtualenv vary based on OS. The vitualenv User Guide has more information.

Windows

To create a new virtual environment:

virtualenv ENV

Where ENV is a directory to place the new virtual environment. Then to activate the new virtual environment:

.\ENV\Scripts\activate

Finally, update pip within the virtual environment, since some versions of virtualenv install very old versions of pip:

(ENV) pip install --upgrade pip

3

https://www.python.org/downloads/

https://pip.pypa.io/en/stable/installing/

http://pythonwheels.com/

https://virtualenv.pypa.io

https://virtualenv.pypa.io/en/latest/userguide.html


Mac/Linux

To create a new virtual environment:

$ virtualenv ENV

Where ENV is a directory to place the new virtual environment. Then to activate the new virtual environment:

$ source ./ENV/bin/activate

Finally, update pip within the virtual environment, since some versions of virtualenv install very old versions of pip:

(ENV) $ pip install --upgrade pip

1.1.3 Install via pip

Within the virtual environment use pip to install SNAPtoolbelt:

(ENV) pip install --extra-index-url https://update.synapse-wireless.com/pypi snaptoolbelt

Try it out:

(ENV) snap version

1.1.4 Optional Steps

There are a few optional steps that you made need when using SNAPtoolbelt.

Autocompletion

To make use of autocompletion in a bash shell, a bash-completion script is available using the snap autocompletecommand:

source $(snap autocomplete)

The script will attempt to tab-complete commands, profiles, networks, and nodes you’ve talked to recently. You canalso link the autocomplete script to your ‘/etc/bash_co

Encryption

To talk to AES-128 encrypted networks, you will also need to install PyCrypto:

• PyCrypto

Within the virtual environment use pip to install PyCrypto:

(ENV) pip install pycrypto

Building SNAPpy Scripts

To build SNAPpy scripts, you will also need to install SNAPbuild and related SNAPcore firmware packages:

(ENV) pip install --extra-index-url https://update.synapse-wireless.com/pypi snapbuild snap-firmware-2.7.1

4 Chapter 1. Getting Started

http://pycrypto.org/


Note: You will need to install package that matches the version of SNAPcore you are using.

Use Outside of Virtualenv

You can use SNAPtoolbelt outside its virtualenv by specifying the full path (or adding it to your own $PATH):

~/.virtualenvs/snaptoolbelt/bin/snap version

You can also symlink from the virtualenv to /usr/local/bin:

ln -s ~/.virtualenvs/snaptoolbelt/bin/snap /usr/local/bin/

1.2 Configuration

SNAPtoolbelt needs to know a few things in order to talk to your SNAP networks:

1. Networks - How your SNAP network is configured

2. Profiles - How to connect to your SNAP network

1.2.1 Networks

A Network describes how a SNAP network is configured. All nodes in the SNAP network need to be configured thesame way. It contains the following parameters:

channel Integer from 0-15 (for 2.4 GHz networks, 0-63 for 900 MHz, default is 4)

network_id (default is 0x1c2c)

encryption_type None, Basic, or AES-128 (default is None)

encryption_key String, up to 16 characters (defaults is ‘’)

feature_bits (defaults is 0x0100)

1.2.2 Profiles

A Profile describes the method in which SNAPtoolbelt will connect to a SNAP Network. Each of the supportedconnection methods (serial, TCP, and MQTT) have specific parameters.

Serial

A Serial Profile is used when you are talking to a serial node such as a SS200, SN220, or SN171 Protoboard. Itcontains the following parameters:

device Device string can be a COM identifier on Windows such as COM1, USB0 for SN132 paddleboards in USBmode, SnapStick0 for SS200s in USB mode, or a device path like /dev/snap1 on POSIX systems.

address Licensed address to use (or blank to use the default)

1.2. Configuration 5


TCP

A TCP Profile is used when you’re talking to a SNAP Connect instance that is accepting TCP connections. It containsthe following parameters:

host Hostname or IP address

port Port to connect to (default is 48625)

ssl Should this connection use SSL? (True or False)

username User to authenticate as

password Password to authenticate with

address Licensed address to use (or blank to use the default)

MQTT

An MQTT Profile is used when you’re talking to a SNAP2MQTT instance via an MQTT gateway. It contains thefollowing parameters:

host Hostname or IP address

port Port to connect to (default is 1883)

ca_certs Path to client SSL certificates

address SNAP2MQTT’s address (default is ‘000080’)

1.2.3 Under the Covers

SNAPtoolbelt stores its configuration in a .snap folder under your user folder:

• %USERPROFILE% on Windows, e.g. “C:\Users\YourName\.snap”

• ~/.snap on Linux/Mac

The configuration (and some other data) is stored in a few files:

profiles.cfg SNAP Profiles, or “how should I talk to your SNAP networks?”

networks.cfg SNAP Networks, or “What networks do you talk to, and how are they configured?”

nodes.cache Node addresses you’ve recently talked to

1.3 Quick Start

If you are using a SNAP Stick such as an SS200 or SN220, SNAPtoolbelt can scan for your node(s):

$ snap config scan

SNAPtoolbelt will automagically add new nodes (including sniffer nodes) to your configuration.

Note: If you get a message about a Read error, you can bypass it by adding the -f/--force flag. Read errorsmay just mean “This node’s actually a SNAP Sniffer, we were looking for non-Sniffer nodes.”, or “It was busy whenwe tried to talk to it.”



To make one of them your default, move it to the default profile:

$ snap config move profile SNAPstick0 default

1.4 Conventions

SNAPtoolbelt is scriptable in addition to being user controlled. If you ask it for information, it will be provided onSTDOUT. Logs and other ancillary chatter are emitted on STDERR. If the command succeeds, the exit status will bezero, otherwise the exit status will be non-zero.

All input needed comes either from the configuration files, or from the invocation.

Note: There are no prompts for “Are you sure?”. If you tell it to erase a script, it will do so or exit(1) trying.

1.4. Conventions 7

CHAPTER 2

Command Reference

2.1 snap

SNAPtoolbelt provides access to the fundamental operation on a SNAP network.

Available Commands

2.1.1 snap config

Available Commands

• snap config profile• snap config network• snap config new profile• snap config new network• snap config list• snap config delete• snap config copy• snap config move• snap config scan• snap config node-cache show• snap config node-cache clear

snap config profile

Description

Display a profile

Usage

snap config profile <name> [key [value]]

9


Positional Arguments

name Name of profile

key (optional) Name of profile parameter to display/set

value (optional) Parameter value to set

Examples

Show the default profile:

snap config profile default

Show the value of the sn220 profile’s device parameter:

snap config profile sn220 device

Set the sn220 profile’s device parameter to /dev/snap1:

snap config profile sn220 device /dev/snap1

snap config network

Description

Display a network

Usage

snap config network <name> [key [value]]


name Name of network

key (optional) Name of network parameter to display/set

value (optional) Parameter value to set

Examples

Show the default network:

snap config network default

Show the lighting network’s encryption_type parameter:

snap config network lighting encryption_type

Set the solar network’s channel parameter to 7:

snap config network solar channel 7

10 Chapter 2. Command Reference


snap config new profile

Description

Creates a new profile based on the profile type (serial, tcp, or mqtt) specified

Usage

snap config new profile (serial|tcp|mqtt) <name> [options]


name Name of profile to be created

Options

-f, --force Overwrite an existing profile/network

Examples

Create a new serial profile named sn132:

snap config new profile serial sn132

Create a new mqtt profile named e20:

snap config new profile mqtt e20

snap config new network

Description

Creates a new network

Usage

snap config new network <name> [options]


name Name of network to be created

Options

-f, --force Overwrite an existing profile/network

2.1. snap 11


Examples

Overwrite the lighting network with a new one:

snap config new network lighting -f

snap config list

Description

List the available profiles/networks

Usage

snap config list (profile|network)

Examples

List all profiles:

snap config list profile

snap config delete

Description

Delete a profile/network

Usage

snap config delete (profile|network) <name>


name Profile/Network to be deleted

Examples

Remove the sn220 profile:

snap config delete profile sn220

Remove the power network:

snap config delete network power



snap config copy

Description

Copy a profile or network

Usage

snap config copy (profile|network) <from> <to>


from Profile/Network to be copied

to Name of new profile/network

Examples

Copy the default profile to snapstick:

snap config copy profile default snapstick

Copy the lighting network to default:

snap config copy network lighting default

snap config move

Description

Move/rename a profile or network

Usage

snap config move (profile|network) <from> <to>


from Profile/Network to be moved/renamed

to New name of profile/network

Examples

Moves the sn220 profile to the default (overriding the current default):

snap config move profile sn220 default

Move the solar network to testbed:

2.1. snap 13


snap config move network solar testbed

snap config scan

Description

Scans serial ports for SNAP nodes and creates profiles for any that don’t already exist in your configuration

Usage

snap config scan [options]

Options

-d, --dry-run Just scan without creating profiles

-f, --force Add nodes that have read errors

Examples

Scan for all nodes:

snap config scan -f

snap config node-cache show

Description

Lists the entries currently in the Node Cache (nodes which will be available when auto-completing node addresses)

Usage


Examples

Show the Node Cache:


snap config node-cache clear

Description

Removes the specified entries from the Node Cache



Usage

snap config node-cache clear (all|<target>)

Examples

Clear the entire cache:

snap config node-cache clear all

Remove 112233 from the cache:

snap config node-cache clear 112233

2.1.2 snap data

Available Commands

• snap data send unicast• snap data send multicast

snap data send unicast

Description

Send Unicast Data

Usage

snap [global options] data send (u | unicast) <target> <data> [-h]


target SNAP address of target node or bridge

data The data to send to remote nodes

Options

--base64 Payload is base64 encoded

Examples

Send 012345 the data This was a triumph.:

snap data send u 012345 "This was a triumph."

2.1. snap 15


snap data send multicast

Description

Send Multicast Data

Usage

snap [global options] data send (m | multicast) <data> [-h] [-g <group>] [-t <ttl>] [--base64]


data The data to send to remote nodes

Options

-g <group>, --group <group> Override the Network’s default multicast group

-t <ttl>, --ttl <ttl> Override the Network’s default multicast TTL

--base64 Payload is base64 encoded

Examples

Broadcast I’m making a note here: HUGE SUCCESS to group 7 with a ttl of 3:

snap data send m "I'm making a note here: HUGE SUCCESS" -g 7 -t 3

2.1.3 snap find

snap find

Description

Finds the target node by sweeping through channels, and optionally moves the node to a new network

Note: Cannot find nodes with different encryption settings from the Network/bridge

Usage

snap [global options] find [-h] <target(s)> [-l <list-file>] [-m <move-to-network>]


target(s) SNAP address of target node, or comma-separated list of addresses



Options

-l <list-file>, --list <list-file> File containing the list of nodes to find

-m <network>, --move <network> Moves the node to the specified network

Examples

Move the bridge node to the lighting network:

snap find bridge -m lighting

Find node 123456:

snap find 123456

2.1.4 snap network

Available Commands

• snap network ping• snap network dm-ping• snap network intercept• snap network listen• snap network topology

snap network ping

Description

Send a multicast query to the network and await unicast replies

Usage

snap [global options] network ping [-h] [-t <timeout>]

Options

-t <seconds>, --timeout <seconds> Number of seconds to wait for replies, default is 20

Examples

Ping the network, but only wait ~5 seconds for replies:

snap network ping -t 5

2.1. snap 17


snap network dm-ping

Description

Send a multicast query to the network and await directed multicast replies

Usage

snap [global options] network dm-ping [-h] [-t <timeout>]

Options

-t <seconds>, --timeout <seconds> Number of seconds to wait for replies, default is 20

Examples

Ping the network, but only wait ~5 seconds for replies:

snap network dm-ping -t 5

snap network intercept

Description

Use this command to listen for an intercepted node’s output. This requires first using the snap node intercept startcommand. If you do not specify the -t option, the intercept will run until you use CTRL-C to abort it.

Usage

snap [global options] network intercept [-h] [-t <timeout>]

Options

-t <seconds>, --timeout <seconds> Number of seconds to intercept messages, default is forever

Examples

Listen for intercepted output:

snap network intercept

Listen for intercepted output for 10 seconds, then quit:

snap network intercept -t 10



See Also

• snap node intercept start

snap network listen

Description

If you don’t have a real sniffer node available, you can always listen for messages that happen to come your way(multicasts, for instance). If you do not specify the -t option, the intercept will run until you use CTRL-C to abort it.

Usage

snap [global options] network listen [-h] [-t <timeout>]

Options

-t <seconds>, --timeout <seconds> Number of seconds to intercept messages, default is forever

Examples

Listen for messages:

snap network listen

Listen for messages for one minute, then exit:

snap network listen -t 60

snap network topology

Description

Gathers the topology of the network.

Usage

snap [global options] network topology [-h]

Examples

Gather the topology:

snap network topology

2.1. snap 19


2.1.5 snap node

Available Commands

• snap node info• snap node info device• snap node info firmware• snap node info mcast• snap node info network• snap node info script• snap node info security• snap node info stats• snap node info uart• snap node info all• snap node traceroute• snap node script• snap node script build• snap node script erase• snap node script info• snap node script upload• snap node firmware info• snap node firmware upload• snap node energy• snap node reboot• snap node nvparam• snap node intercept• snap node move

snap node info

Description

Get summary information about the <target> node. By default it queries:

• Current Channel (i.e. “Where is this node now?”)

• Current Network ID

• NVParam Channel (i.e. “Where will this node go if it’s rebooted?”)

• NVParam Network ID

• Feature Bits

• Vendor settings

• Encryption Type

• Lockdown Bitmask

• Current Script Name

• Current Script CRC

• Current Firmware version

• Current Firmware category



Usage

snap [global options] node <target> info [-h] [summary]



Examples

Ask the bridge node for its summary information:

snap node bridge info

snap node info device

Description

Gets device information about the <target> node:

• Address

• Feature Bits

• Device Name

• Platform

• Device Type

• Vendor Settings

Usage

snap [global options] node <target> info device [-h]



Examples

Ask the bridge node for its device information:

snap node bridge info device

2.1. snap 21


snap node info firmware

Description

Gets firmware information about the <target> node:

• Core Version

• Platform

• Platform Category

Usage

snap [global options] node <target> info firmware [-h]



Examples

Ask the bridge node for its firmware information:

snap node bridge info firmware

snap node info mcast

Description

Gets mcast information about the <target> node:

• Carrier Sense

• Collision Avoidance

• Collision Detect

• CS/CD Threshold

• CSMA Settings

• Multicast Forwarded Groups

• Multicast Processed Groups

• Serial Multicast Forwarded Groups

Usage

snap [global options] node <target> info mcast [-h]





Examples

Ask the bridge node for its mcast information:

snap node bridge info mcast

snap node info network

Description

Gets network information about the <target> node:

• Channel

• Default Radio Rate

• Network ID

• Radio LQ Threshold

• Radio Unicast Retries

Usage

snap [global options] node <target> info network [-h]



Examples

Ask the bridge node for its network information:

snap node bridge info network

snap node info script

Description

Gets script information about the <target> node:

• Script CRC

• Script Name

2.1. snap 23


Usage

snap [global options] node <target> info script [-h]



Examples

Ask the bridge node for its script information:

snap node bridge info script

snap node info security

Description

Gets security information about the <target> node:

• Encryption Type

• Lockdown Bitmask

Note: The Encryption Key is intentionally not queried or displayed. (If you can talk to the node, you already havethe correct encryption key.)

Usage

snap [global options] node <target> info security [-h]



Examples

Ask the bridge node for its security information:

snap node bridge info security

snap node info stats

Description

Gets stats from the <target> node:



• Null Transmit Buffers

• Transparent Receive Buffers

• Transparent Transmit Buffers

• UART0 Receive Buffers

• UART0 Transmit Buffers



• Packet Serial Forwarded Unicasts

• Packet Serial Forwarded Multicasts

• Packet Serial Receive Buffers

• Packet Serial Transmit Buffers

• Radio Forwarded Unicasts

• Radio Forwarded Multicasts

• Radio Receive Buffers

• Radio Transmit Buffers

Usage

snap [global options] node <target> info stats [-h]



Examples

Ask the bridge node for its stats:

snap node bridge info stats

snap node info uart

Description

Gets UART information from the <target> node:

• Buffering Threshold

• Buffering Timeout

• Default UART

• Intercharacter Timeout

• UART0 Default Baud Rate

• UART1 Default Baud Rate

2.1. snap 25


Usage

snap [global options] node <target> info uart [-h]



Examples

Ask the bridge node for its UART information:

snap node bridge info uart

snap node info all

Description

Gets all information from the <target> node:

• Device

• Firmware

• Mcast

• Mesh

• Network

• Script

• Security

• Stats

• Summary

• UART

Usage

snap [global options] node <target> info all [-h]



Examples

Ask the bridge node for all its information:



snap node bridge info all

snap node traceroute

Description

Performs a traceroute to the target node. Returns the round trip time and link quality information for each hop alongthe way. See the SNAP Manual for more details on the traceroute process.

Node Traceroute

Usage

snap node <target> traceroute



Examples

Traceroute to 00aabb:

snap node 00aabb traceroute

snap node script

Description

Queries the script name and CRC. Erases the script on the target node. Loads the <spy_file> over-the-air on the<target> node.

Usage

snap node <target> script (build | erase | info | upload) [options]



Examples

Ask the bridge for its script information:

snap node bridge script info

2.1. snap 27


Erase the script on node 987654:

snap node 987654 script erase

Upload SnapStick.spy on the bridge:

snap node bridge script upload SnapStick.spy

snap node script build

Description

Build the script for the TARGET node. Uses SNAPbuild to compile the script to a SPY file for that node’s moduleand core.

By default the output .spy/.map files are placed in the current working directory, use -o to override.

Note: This command requires SNAPbuild to be installed

Usage

snap [global options] node <target> script build <script> [-h] [-I include [...]] [-o output]



script The .py SNAPpy script to build.

Options

-I <include> Additional SNAPpy script import path (repeat to include multiple paths)

-o <output_path> Path to save the .spy and .map files

Examples

Build SnapStick.py for the bridge node:

snap node bridge script build SnapStick.py

snap node script erase

Description

Erase the script on the <target> node.



Usage

snap [global options] node <target> script erase [-h]



Examples

Erase the script from the bridge node:

snap node bridge script erase

snap node script info

Description

Gets script information about the <target> node:

• Script CRC

• Script Name

Usage

snap [global options] node <target> script info [-h]



Examples

Ask the bridge node for its script information:

snap node bridge script info

snap node script upload

Description

Uploads the script to the <target> node. Uses SNAPbuild to compile the script to a SPY file for that node’s moduleand core. If <script> is already a SPY file, just upload it without rebuilding.

Note: This command requires SNAPbuild to be installed.

2.1. snap 29


Usage

snap [global options] node <target> script upload <script.[s]py> [-h] [-I include [...]]



script The .py SNAPpy script (or .spy SNAPpy script image) to upload to the node.

Options

-I <include> Additional SNAPpy script import path (repeat to include multiple paths)

Examples

Upload SnapStick.py to the bridge node:

snap node bridge script upload SnapStick.py

snap node firmware info

Description

Gets firmware information about the <target> node:

• Core Version

• Platform

• Platform Category

Usage

snap [global options] node <target> firmware info [-h]



Examples

Ask the bridge node for its firmware information:

snap node bridge firmware info



snap node firmware upload

Description

Load the specified firmware on the <target> module.

Usage

snap [global options] node <target> firmware upload [-h] (<core> | -f <sfi-file>)



core The version of SNAPcore to load

Options

-f <sfi-file>, --file <sfi-file> If firmware support package is not installed, an SFI file path can be pro-vided

Examples

Load the 2.7.1 firmware on node 012345:

snap node 012345 firmware upload 2.7.1

Load the RF200_AES128_SnapV2.6.2.sfi firmware on node 00aabb:

snap node 00aabb firmware upload -f RF200_AES128_SnapV2.6.2.sfi

snap node energy

Description

Performs an energy scan on a node across all of its channels and returns a list of “clear percentages”. These percentagescan be used to determine the least noisy channel to use for communication.

Usage

snap node <target> energy [options]



2.1. snap 31


Options

-n <number>, --num_queries <number> Perform <number> queries and average the results

-d <delay>, --delay <delay> Wait for <delay> seconds between queries

-c <cutoff>, --cutoff <dbm> Cutoff value for the dBm floor

Examples

Ask the bridge node to scan 3 times, waiting 2 seconds between scans:

snap node bridge energy -n 3 -d 2

snap node reboot

Description

Ask the target node to reboot, with an optional <delay>

Usage

snap node <target> reboot [<delay>]



delay Optional milliseconds the node should wait between receiving the RPC and actually rebooting.

Examples

Reboot the bridge node:

snap node bridge reboot

snap node nvparam

Description

Either reset the <target> node NVParams to factory default, or query the <target> node for the value of NVParam<nvparam_id> and optioanlly set it <value>. Values are parsed like RPC arguments.

You can reference NVParams by name, see snap help nvparam for details.

Warning: The changes do not take effect until you reboot the node, see snap node reboot



Usage

snap node <target> (reset | nvparam <nvparam_id> [<value>]...)



nvparam_id The ID (integer or name) of the nvparam

value If provided, set the nvparam to this value.

Examples

Ask the bridge node for the value of NVParam 128:

snap node bridge nvparam 128

Ask node 123456 for its mesh routing max hop limit:

snap node 123456 nvparam mesh.routing.max-hop-limit

Set NVParam 110 to foo on node 012345:

snap node 012345 nvparam set 110 'foo'

Set the multicast forwarded groups on the bridge node to 5:

snap node bridge nvparam set mcast.forwarded-groups 5

Reset node 001122 NVParams to factory defaults:

snap node 001122 nvparam reset

See Also

• snap node reboot

snap node intercept

Description

Tell the <target> node to start/stop sending its STDOUT and/or STDERR to us

Note: Use the cli:snap mesh intercept command to listen for the output after telling a node to start.

Usage

snap [global options] node <target> intercept [-h] (start [--out-only | --err-only] | stop)

2.1. snap 33




Options

--out-only Send only STDOUT.

--err-only Send only STDERR.

Examples

Ask node 001122 to start sending us both STDOUT and STDERR:

``snap node 001122 intercept start``

Ask node 001122 to stop sending us output:

snap node 001122 intercept stop

See Also

• snap network intercept

snap node move

Description

Moves the <target> node to the specified <network>. You must be able to reach the node on the current network. If the<target> node is the bridge, this command also updates the “last used” network for the current profile to the <target>network.

Usage

snap [global options] node <target> move [-h] <network>



network Name of SNAP Network the node should move to.

Examples

Move the bridge to the ‘lighting’ network:

snap node bridge move lighting

Move node 001122 to the ‘power’ network:



snap node 001122 move power

2.1.6 snap recover

Note: On the E20 (and other gateways) when issuing the recovery commands you may need to use sudo ‘whichsnap‘ to provide sudo the full path to where SNAPtoolbelt is installed:

sudo `which snap` recover erase-script SM220

Available Commands

• snap recover erase-script• snap recover default-nvparam• snap recover firmware• snap recover sniffer

snap recover erase-script

Description

Erase any script on the connected module

Usage

snap [global options] recover erase-script [-h] <module>


module_type The type of SNAP module that is connected via the recover port

Examples

Erase any script on the connected SS200 module:

snap recover erase-script SS200

snap recover default-nvparam

Description

Restore the NV Params to the factory defaults on the connected module

2.1. snap 35


Usage

snap [global options] recover default-nvparam [-h] <module>



Examples

Factory default the NV Params on the connected SS200 module:

snap recover default-nvparam SS200

snap recover firmware

Description

Load the specified firmware Load the specified firmware on the connected module via the bootloader

Usage

snap [global options] recover firmware [-h] <module> (<core> | -f <sfi-file>)



core_version The version of SNAPcore to load

Options


Examples

Once you have pip installed the snap-firmware-2.7.1 package you will be able to load SNAPcore version 2.7.1on the connected SM220UF1 module:

snap recover firmware SM220UF1 2.7.1

If you have not installed the snap-firmware package, you can still load firmware by specifying an SFI file:

snap recover firmware SS200 2.6.2 -f ./sfifiles/RF200_AES128_SnapV2.6.2.sfi



snap recover sniffer

Description

Load the sniffer firmware on the connected module via the bootloader

Usage

snap [global options] recover sniffer [-h] <module> [-f <sfi-file>]



Options


Examples

Load sniffer firmware on the connected RF220SU module:

snap recover sniffer RF220SU

Load sniffer firmware on the connected SS200 module by specifying an SFI file:

snap recover sniffer SS200 -f ./sfifiles/ATmega128RFA1_SnifferV1.3.0.sfi

2.1.7 snap rpc

Available Commands

• snap rpc call unicast• snap rpc call multicast• snap rpc call directed-multicast• snap rpc send unicast• snap rpc send multicast• snap rpc send directed-multicast

snap rpc call unicast

Description

Callback Unicast RPC

2.1. snap 37


Usage

snap [global options] rpc call (u | unicast) <target> <func> [<args>...] [-h] [-c <callback-name>]



func Name of function to call on targets

args A list of arguments to pass to the function (space-delimited, use quotes to pass an argument with whitespace.)

Options

-c <name>, --callback-name <name> Specify which function will be called on a response from thetargets

Examples

Ask the bridge node getInfo(5):

snap rpc call u bridge getInfo 5

Ask the bridge node vmStat(6), expect it to return its result via tellVmStat:

snap rpc call u bridge vmStat 6 --callback-name tellVmStat

snap rpc call multicast

Description

Callback Multicast RPC

Usage

snap [global options] rpc call (m | multicast) <targets> <func> [<args>...] [-h] [-g <group>] [-t <ttl>] [-c <callback-name>]


targets A comma separated list of SNAP addresses





Options




Examples

Broadcast a request for getInfo(5), expect responses from 123456 and 789abc:

snap rpc call m 123456,789abc getInfo 5

snap rpc call directed-multicast

Description

Callback Directed Multicast RPC

Usage

snap [global options] rpc call (d | dm | directed-multicast) <targets> <func> [<args>...] [-h] [-g <group>] [-t <ttl>] [-d <delay>] [-c <callback-name>]





Options



-d <delay>, --delay <delay> Specify a response delay in milliseconds from the targets, default is 0


Examples

Directed Multicast a request for getInfo(5) to 123456 and 789abc, ask them to delay their responses into100ms windows:

snap rpc call dm 123456,789abc getInfo 5 --delay 100

2.1. snap 39


snap rpc send unicast

Description

Send Unicast RPC

Usage

snap [global options] rpc send (u | unicast) <target> <func> [<args>...] [-h]





Examples

Send ping() to the bridge node:

snap rpc send u bridge ping

snap rpc send multicast

Description

Send Multicast RPC

Usage

snap [global options] rpc send (m | multicast) <func> [<args>...] [-h] [-g <group>] [-t <ttl>]




Options





Examples

Broadcast hunt():

snap rpc send m hunt

snap rpc send directed-multicast

Description

Send Directed Multicast RPC

Usage

snap [global options] rpc send (d | dm | directed-multicast) <targets> <func> [<args>...] [-h] [-g <group>] [-t <ttl>] [-d <delay>]





Options



-d <delay>, --delay <delay> Specify a response delay in milliseconds from the targets, default is 0

Examples

Send nodes 001122, 334455, and 667788 the RPC getData(17, ’blue’, 22):

snap rpc send dm 001122,334455,667788 getData 17 'blue' 22

2.1.8 snap update

Available Commands

• snap update check• snap update install

2.1. snap 41


snap update check

Description

List SNAPtoolbelt packages that may be out of date (equivalent of pip list --outdated)

Usage

snap [global options] update check [-h] [--pre]

Options

--pre Allow pre-release (alpha/beta/rc) packages

Examples

snap update check

snap update install

Description

Install SNAPtoolbelt packages that may be out of date (equivalent of pip install --upgrade)

Usage

snap [global options] update install [-h] [--pre]

Options

--pre Allow pre-release (alpha/beta/rc) packages

Examples

snap update install

Note:

• Multicast Group, TTL, and DMCast Delay are all given default values in the Network configuration, but maybe overridden per-command here.

• All target addresses must be in 6-character form: 0deCAF, 012345.

• The special address “bridge” can be used to specify your connection’s bridge node, even if the exact address isnot known. (One way to discover your bridge node’s address is to use snap node info.)

• Arguments in quotes ("test", ’abc’) are parsed as strings.



• "" and ’’ are both parsed as empty strings.

• All numbers are parsed as integers: (0x10 == 16, 100 == 100)

• Booleans (True, False) are parsed as booleans

• None is parsed as None (Pythonic None, not the string ’None’)

• Strings beginning with x that look like hex data will be unhexlify’d: xabcdef == ’\xab\xcd\xef’

2.2 Global Options

SNAPtoolbelt commands are nested. Global options must come after the initial snap, but before the first subcom-mand. These options can be used with all commands.

snap [global-options] subcommand ...

2.2.1 Log Level

-l (debug|info|warn|error|critical), --log-level (debug|info|warn|error|critical)

Specify the level at which SNAPtoolbelt should log.

Note: SNAPtoolbelt always logs to STDERR. If you need to log to a file, you will need to redirect STDERR usingyour shell of choice.

2.2.2 Output Formats

-o (dkvp|json|json-pretty|tab), --output-format (dkvp|json|json-pretty|tab)

By default, the output is provided in Delimited Key-Value Pair format. MLR can be used to convert DKVP into CSVor other formats.For example, the (partial) output of a node info query in DKVP:

current.channel=8,current.network-id=0xbbbb,device.core=2.7.1,device.feature-bits=0x001f,device.platform=SS200,device.script-crc=0xf50d

JSON output is also possible:

{"current.channel": 8, "current.network-id": "0xbbbb", "device.core": "2.7.1", "device.feature-bits": "0x001f", "device.platform": "SS200", "device.script-crc": "0xf50d"}

As is tabular output:

current.channel 8current.network-id 0xbbbbdevice.core 2.7.1device.feature-bits 0x011fdevice.platform RF200device.script-crc 0xcc65

2.2.3 Profile

-p <profile>, --profile <profile>

Specify which profile you want to use, default is the default.

2.2. Global Options 43


2.2.4 Network

-n <network>, --network <network>

Specify which network you want to use, default is the default.


CHAPTER 3

License

See https://www.synapse-wireless.com/sdklicense.

45

https://www.synapse-wireless.com/sdklicense

snaptoolbelt - read the docs · 2019. 4. 2. · mode, snapstick0for ss200s in usb mode, or a device...

Documents