aws_project - bruno-beloff/scs_mfr GitHub Wiki

docs > software repositories > scs_mfr > commands > AWS data infrastructure


DESCRIPTION

The aws_project utility is used to specify the topic path names for devices using the South Coast Science / AWS IoT messaging infrastructure. For each device, topics are divided into two groups:

Location path, e.g.:

  • south-coast-science-dev/development/loc/1/climate
  • south-coast-science-dev/development/loc/1/gases
  • south-coast-science-dev/development/loc/1/particulates

Device path, e.g.:

  • south-coast-science-dev/development/device/alpha-pi-eng-000006/control
  • south-coast-science-dev/development/device/alpha-pi-eng-000006/status

Typically, the device paths should remain fixed throughout the lifetime of the device. In contrast, a given set of location paths are used by the device only when it is installed at a given location.

The location ID may be an integer or a string.

When the "verbose" "-v" flag is used, the aws_project utility reports all of the topic paths derived from its specification.

Note that the scs_mfr/aws_mqtt_client process must be restarted for changes to take effect.

SYNOPSIS

aws_project.py [-s ORG GROUP LOCATION] [-d] [-v]

Options
--version show program's version number and exit
-h, --help show this help message and exit
-s PROJECT, --set=PROJECT set project specification
-d, --delete delete the project reference
-v, --verbose report narrative to stderr

EXAMPLES

./aws_project.py -s south-coast-science-dev development 1

DOCUMENT EXAMPLE

{"location-path": "south-coast-science-dev/development/loc/1", "device-path": "south-coast-science-dev/development/device"}

FILES

~/SCS/aws/aws_project.json

SEE ALSO

scs_dev/aws_mqtt_client

scs_mfr/aws_client_auth