system_id - bruno-beloff/scs_mfr GitHub Wiki

docs > software repositories > scs_mfr > commands > system identity


DESCRIPTION

The system_id utility is used to specify the identity of a sensing device, as it appears on either the South Coast Science / AWS or OpenSensors.io Community Edition messaging infrastructures.

The identity is also used to tag all environmental sensing records. It is therefore important that a device retains a fixed identity throughout its lifetime.

When the "verbose" "-v" flag is used, the system_id utility reports all of the identity formats derived from its specification.

SYNOPSIS

system_id.py [-d VENDOR_ID] [-m MODEL_ID] [-n MODEL_NAME] [-c CONFIG] [{-s SYSTEM_SERIAL_NUMBER | -a }] [-v]

Options
--version show program's version number and exit
-h, --help show this help message and exit
-d VENDOR_ID, --vendor=VENDOR_ID set vendor ID
-m MODEL_ID, --model=MODEL_ID set model ID
-n MODEL_NAME, --name=MODEL_NAME set model name
-c CONFIGURATION, --config=CONFIGURATION set device configuration
-s SERIAL_NUMBER, --serial=SERIAL_NUMBER set serial number
-a, --auto-serial set serial number automatically from hostname
-v, --verbose report narrative to stderr

EXAMPLES

./system_id.py -v -d SCS -m BGX -n Praxis -c BGX -s 401

DOCUMENT EXAMPLE

{"vendor-id": "SCS", "model-id": "BGX", "model": "Praxis", "config": "BGX", "system-sn": 401}

FILES

~/SCS/conf/system_id.json

SEE ALSO

scs_dev/aws_topic_publisher
scs_dev/aws_topic_subscriber
scs_dev/climate_sampler
scs_dev/gases_sampler
scs_dev/particulates_sampler
scs_dev/status_sampler
scs_dev/control_receiver

scs_mfr/cognito_device_credentials