- Getting Started
- Examples
- SNAP Modules
- SNAPconnect Gateways
- Prototyping
- SNAP Reference
- SNAPstack
- SNAPtoolbelt
- SNAPcompiler
- Legacy
toolbelt config¶
toolbelt config profile¶
Description¶
Display a profile
Usage¶
- toolbelt config profile <name> [key [value]]
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:
toolbelt config profile default
Show the value of the sn220
profile’s device
parameter:
toolbelt config profile sn220 device
Set the sn220
profile’s device
parameter to /dev/snap1
:
toolbelt config profile sn220 device /dev/snap1
Set the fast
profile`s speed
parameter to 115200:
toolbelt config profile fast speed 115200
toolbelt config network¶
Description¶
Display a network
Usage¶
- toolbelt config network <name> [key [value]]
Positional Arguments¶
- name
Name of network
- key
(optional) Name of network parameter to display/set
- value
(optional) Parameter value to set
Examples¶
Show the default
network:
toolbelt config network default
Show the lighting
network’s encryption_type
parameter:
toolbelt config network lighting encryption_type
Set the solar
network’s channel
parameter to 7
:
toolbelt config network solar channel 7
Set the lighting
network’s encryption_key
parameter:
toolbelt config network lighting encryption_key "\x00\x01\x02\x03\x04\x05\x06\x0789abcdef"
toolbelt config new profile¶
Description¶
Creates a new profile based on the profile type (serial
, tcp
) specified
Usage¶
- toolbelt config new profile (serial|tcp) <name> [options]
Positional Arguments¶
- name
Name of profile to be created
Options¶
- -f, --force
Overwrite an existing profile/network
Examples¶
Create a new serial profile named sn132
:
toolbelt config new profile serial sn132
Create a new tcp profile named e20
:
toolbelt config new profile tcp e20
toolbelt config new network¶
Description¶
Creates a new network
Usage¶
- toolbelt config new network <name>
Positional Arguments¶
- name
Name of network to be created
toolbelt config list¶
Description¶
List the available profiles/networks
Usage¶
- toolbelt config list (profile|network)
toolbelt config show¶
Description¶
Show a profile/network. (Same as toolbelt config profile <name>
or toolbelt config network <name>
)
Usage¶
- toolbelt config cat (profile|network) <name>
toolbelt config delete¶
Description¶
Delete a profile/network
Usage¶
- toolbelt config delete (profile|network) <name>
Positional Arguments¶
- name
Profile/Network to be deleted
Examples¶
Remove the sn220
profile:
toolbelt config delete profile sn220
Remove the power
network:
toolbelt config delete network power
toolbelt config copy¶
Description¶
Copy a profile or network
Usage¶
- toolbelt config copy (profile|network) <from> <to>
Positional Arguments¶
- from
Profile/Network to be copied
- to
Name of new profile/network
Examples¶
Copy the default
profile to snapstick
:
toolbelt config copy profile default snapstick
Copy the lighting
network to default
:
toolbelt config copy network lighting default
toolbelt config move¶
Description¶
Move/rename a profile or network
Usage¶
- toolbelt config move (profile|network) <from> <to>
Positional Arguments¶
- 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):
toolbelt config move profile sn220 default
Move the solar
network to testbed
:
toolbelt config move network solar testbed
toolbelt config scan¶
Description¶
Scans serial ports for TOOLBELT nodes and creates profiles for any that don’t already exist in your configuration
Usage¶
- toolbelt config scan [options]
Options¶
- -f, --force
Add nodes that have read errors
- -u <profile>, --update <profile>
Update an additional profile (e.g. default)
- -m <regex>, --matching <regex>
Limit search to paths matching the provided regex [default: .*]
Examples¶
Scan for all nodes:
toolbelt config scan -f
Scan for /dev/tty.usbserial
nodes, and update the default profile w/ the last match found:
toolbelt config scan -u default -m /dev/tty.usbserial