manualshive.com logo in svg

ARRIBADA Horizon ARTIC R2, Users Manual & Quick Start Manual, Page: 41 / 42

Share
Download
ARRIBADA Horizon ARTIC R2 Users Manual & Quick Start Manual Download Page 41

Page 41 of 42

Field Name

Presence

Type

Notes

Logging Filter Enable Tag

"__dt"

Mandatory

String

Delta time since previous
logged item

-

"thing_name"

Mandatory

String

The AWS registered thing
name associated with the
data record

-

"timestamp"

Mandatory

Integer

Number of seconds since the
epoch

Derived from either "TIMESTAMP" or "DATETIME".  In either case it
shall be converted to a "timestamp" value by the AWS lambda function
processing.

"longitude"

Mandatory

Float

GPS longitude co-ordinate

"GPS"

"latitude"

Mandatory

Float

GPS latitude co-ordinate

"GPS"

"height"

Mandatory

Float

GPS height in metres

"GPS"

"h_acc"

Mandatory

Float

GPS horizontal accuracy in
metres

"GPS"

"v_acc"

Mandatory

Float

GPS vertical accuracy in
metres

"GPS"

"ttff"

Optional

Integer

Time To First Fix in seconds

"GPS"

7.8.3. Battery data set

Field Name

Presence

Type

Notes

Logging Filter Enable Tag

"__dt"

Mandatory

String

Delta time since previous logged item

-

"thing_name"

Mandatory

String

The AWS registered thing name associated with the data record

-

"timestamp"

Mandatory

Integer

Number of seconds since the epoch

-

"battery_level"

Optional

Integer

"BATTERY_LEVEL"

"battery_voltage"

Optional

Integer

"BATTERY_VOLTAGE"

7.9. AWS device shadow JSON record format

Arribada Horizon ARTIC R2 Developer’s Kit | User Manual

Summary of Contents for Horizon ARTIC R2

Page 1: ...Arribada Horizon Arribada Horizon ARTIC R2 Developer s Kit User Manual Quickstart Guide Version 1 0 2 April 2020 HORIZON DEV ARTIC R2 https arribada org hello arribada org ...

Page 2: ...4 Program the JSON configuration file 5 15 Create an empty log file 5 16 Test modes 5 16 1 Maximizing GPS TTFF performance 5 16 2 Checking IOT cellular connectivity 5 16 3 Sending a satellite test message 6 Post provisioning guide 6 1 Test modes 6 2 GPS 6 3 IOT connectivity and data management 6 4 Extracting data using AWS tools 6 4 1 Obtain a list of registered devices 6 4 2 Obtain the current de...

Page 3: ...r or equivalent required for programming nRF52840 device 2 2 Software The following release packages should be downloaded and installed by cloning the following git repository https github com arribada Python tools software package arribada_tools 2 0 0 zip nRF52840 bootloader file https github com arribada horizon v9 firmware blob master horizon_bootloader_18a6102 hex nRF52840 firmware image DFU f...

Page 4: ...rd via the picoblade connector Attach the antenna via a cable to the U FL antenna connector left edge connector Attach the Horizon board to the module via the picoblade connector edge Arribada Horizon ARTIC R2 Developer s Kit User Manual ARTIC R2 Developer s Kit Contents 1 x Horizon board 1 x ARTIC R2 module daughterboard 1 x Picoblade cable assembly 1 x MicroUSB cable The main Horizon board accep...

Page 5: ...ow above then run the following commands from the arribada_nrf52840_tracker root directory make C ports nrf52840 bootloader erase make C ports nrf52840 bootloader flash_softdevice make C ports nrf52840 bootloader flash To confirm the board is correctly programmed power it and check that the LED indicator is cycling between red green and blue 3 0 1 Application programming via secure bootloader pip ...

Page 6: ...during boot up Refer to UART debug output trace for more information Solid Red Missing configuration file or log file ie provisioning incomplete Green Configuration file checks passed LED will stay on for 5 seconds Flashing White GPS test fix Solid White GPS test fix locked and fixed for minimum required time period LED will stay on for 5 seconds Flashing Yellow Test cellular data connection in pr...

Page 7: ...the left hand side Groups Click the button at the top of the screen Create New Group When prompted for a group name enter and then click the button at the bottom IoTConsumer Next Step On the screen enter the keyword iotanalytics into the filter and select the checkbox next to the Attach Policy AWSIoTAnalyticsRead policy Click the button at the bottom OnlyAccess Next Step Review the settings you ha...

Page 8: ...7 748 aws_config INFO Generating root CA certificate for arribada 2019 03 28 15 32 47 886 aws_config INFO Installing arribada onto AWS 2019 03 28 15 32 47 886 aws INFO register_root_ca 2019 03 28 15 32 47 906 credentials INFO Found credentials in shared credentials file aws credentials 2019 03 28 15 32 49 324 aws INFO create_iot_policy 2019 03 28 15 32 50 237 aws INFO create_iot_thing_group 2019 0...

Page 9: ... 34 03 Running PythonPipBuilder CopySource Build Succeeded Built Artifacts aws sam build Built Template aws sam build template yaml Commands you can use next Invoke Function sam local invoke Package sam package s3 bucket yourbucket Uploading to 9609bf1b3f7d1e52c6b7de5b40d4eeb7 3933 3933 0 100 00 Successfully packaged artifacts and wrote output template to file tmp tmp yaml Execute the following co...

Page 10: ... should be carried out for each tracker board Admin Before executing the above steps please ensure that the AWS tool is installed and on your as described in the sam PATH Plastic section Tracker Quick Start Guide Prerequisites The file is an automatically generated file It is the root CA certificate that has now been installed for your AWS arribada cert account and is used as the root CA for gener...

Page 11: ...53786796 version 1 Note that should be unique for each tracker board being registered Upon completion the following new files should be visible in yourThingName the certificates directory ls la yourThingName rw rw r 1 liamw liamw 1135 Mar 28 15 26 yourThingName cert rw rw r 1 liamw liamw 1704 Mar 28 15 26 yourThingName key rw rw r 1 liamw liamw 451 Mar 28 15 26 yourThingName pubkey The file is an ...

Page 12: ...ameters that should be set as follows For the IOT configuration the following fields are needed for the device specific IOT cellular AWS configuration version 1 Recommended to be set to 1 for first file version iot cellular aws arn xxxxxxxxx iot us west 2 amazonaws com thingName yourThingName Note that the value for the field can be obtain by running the following command arn aws_config get_iot_en...

Page 13: ...existing configuration This command will erase all existing configuration settings held in RAM before proceeding with provisioning sudo tracker_config erase Now confirm the currently active configuration stored in RAM is empty sudo tracker_config read current_config json cat current_config json version 0 TBD will this be the default version when the system is not programmed logging fileSize 0 file...

Page 14: ... the u center tool To apply the GPS ASCII configuration to the Horizon board enter the following command sudo gps_ascii_config file ublox_gnss_configuration dat The GNSS settings are configured broadly as follows Hot start GNSS GPS reporting once per second Optimised for maritime tracking applications All GNSS satellite systems enabled Reporting of TTFF and POS messages only 5 12 Program the ARTIC...

Page 15: ...ode MB secondsSinceEpoch 1566167445 params 7195 586 98 7004 345 036 25 34 101 3591 0 0 satelliteCode MC secondsSinceEpoch 1566170008 params 7226 502 99 181 268 188 25 5 102 0106 1 98 satelliteCode 19 secondsSinceEpoch 1566167176 params 7160 249 98 5406 112 607 25 154 100 6149 0 0 satelliteCode SR 5 14 Program the JSON configuration file The system configuration file is described using JSON Refer t...

Page 16: ...used to ascertain the status of the GPS test mode process LED flashing green waiting for GPS test fix or GPS test fix lost during hold period LED solid green fix found waiting for hold period to elapse LED off hold period elapsed with continual GPS lock 5 16 2 Checking IOT cellular connectivity In order to ensure that the cellular connectivity is working properly it is recommended to activate cell...

Page 17: ... time series record of all battery updates not just the last known battery level All data sets are organized into records continaining the that originated the data a of when the data was generated and a thingName timestamp set of fields that represent the data record itself More information about the structure of each data set can be found in the appendices section A WS data set file format 6 4 Ex...

Page 18: ...urrent value of all fields that been set state delta under state desired 6 4 3 Obtain a list of implemented data sets This command may only be run by a user in the or group Admin IOTConsumer aws_config list_datasets 2019 03 29 11 23 34 217 credentials INFO Found credentials in shared credentials file aws credentials u arribada_battery_charge u arribada_device_status u arribada_gps_location 6 4 4 D...

Page 19: ...ta set fields are represented as strings with their values in double quotes this is a quirk of the AWS IoT data set functionality but stripping of double quotes can be easily done as part of data post processing The data set file name is automatically generated by AWS infrastructure and changes whenever the data set contents change When a data set has not changed the file name remains the same ie ...

Page 20: ...e url domain arribada s3 amazonaws com path f99f1395 dbef 4032 aebc d01d21b55cf6 AWSAccessKeyId AKIAIPZT2EDQFBIJHOWA Expires 1585394885 Signature 2F 2Fabi 2BYo8 2FGd69yfB3L2Pk3MEGs 3D port 443 version 2 timestamp 1553858886 version 3 Arribada Horizon ARTIC R2 Developer s Kit User Manual ...

Page 21: ...edentials 2019 03 29 11 29 12 886 aws_config INFO Notifying device shadow update for yourThingName metadata desired device_update configuration_update url domain timestamp 1553858954 path timestamp 1553858954 port timestamp 1553858954 version timestamp 1553858954 state desired device_update configuration_update url domain arribada s3 amazonaws com path dd2eaae2 b564 415c bd14 67a7e03a9b7b AWSAcces...

Page 22: ...Page 22 of 42 version 1 timestamp 1553858954 version 4 Arribada Horizon ARTIC R2 Developer s Kit User Manual ...

Page 23: ...uracyHorizontal 13 201 longitude 2 1183889 height 0 009 iTOW 401082000 latitude 51 3764057 accuracyVertical 1 558 7 Appendices 7 1 Advanced combining of commands To save time it is possible to combine multiple commands together For example sudo tracker_config erase_log create_log LINEAR setdatetime date write configuration_v4 json read verif json read_log log bin The above command will execute the...

Page 24: ... adapter is available and enabled This is required to be done every time your Linux PC is booted This is best achieved using and as follows hcitool hciconfig Confirm BLE device is present and enabled hcitool dev Devices hci0 F4 B7 E2 4B 4D 6C hciconfig hci0 up Find source code distribution of arribada_tool python package cd arribada tools x y z tests export HCI_DEV 0 sudo setup_ble sh Note that if...

Page 25: ...5 957433 60 6 126393 795379538 50 957217 61 861 123789 398813469 65 957245 63 352 120879 530243718 72 957329 65 106 117633 274966977 78 957357 65 464 116993 400953196 82 957385 109 791 69760 5450355676 90 Fail A typical value of RSSI is 30 dBm with 1 cm separation between antennas The operational link range is 10 15 meters based on using 1M PHY mode and 0 dBm transmit power 7 2 6 2 GPS device prog...

Page 26: ...ll have a new log file created should be used in combination with log_erase config each serviced device shall be programmed with a new JSON configuration file datetime synchronize the tracker s RTC to the local time on the PC reset the processor shall be hard reset upon completion of all other batch processing tasks Each command line option effectively represents a different task to be carried out...

Page 27: ... bb 32 2018 10 31 15 08 41 560 ble_auto INFO Connecting to device ee fa 05 ba 86 8b 2018 10 31 15 08 41 774 ble_auto INFO Processing tasks for device ee fa 05 ba 86 8b 2018 10 31 15 08 41 775 ble_auto INFO Reading status from device ee fa 05 ba 86 8b 2018 10 31 15 08 42 832 ble_auto INFO Status for device ee fa 05 ba 86 8b id 00 00 00 00 00 00 00 00 status cfg_version 4 ble_fw_version 65704 fw_ver...

Page 28: ... Latitude degrees iTOW number iTOW time in seconds longitude number Longitude degrees height number Height in metres Surfaced Salt water switch surfaced detection event Submerged Salt water switch submerged detection event BatteryCharge charge number Charge level indicator 0 100 BatteryVoltage voltage number Battery voltage reading from ADC BluetoothEnable cause number BluetoothDisable cause numbe...

Page 29: ...umber IOTFirmwareUpdate Notification an IOT firmware file update was received version number file_length number IOTErrorCode Notification of error code when an IOT error occurs error_code number IOTStatus status string Indication of current IOT connectivity status Arribada Horizon ARTIC R2 Developer s Kit User Manual ...

Page 30: ...escribe the different GPS trigger options Any arrows on rising edges is the cause for the GPS to turn on any arrow on a falling edge is the cause for the GPS to turn off 7 5 1 SWITCH_TRIGGERED 7 5 2 SCHEDULED Arribada Horizon ARTIC R2 Developer s Kit User Manual ...

Page 31: ...Page 31 of 42 7 5 3 HYBRID Arribada Horizon ARTIC R2 Developer s Kit User Manual ...

Page 32: ...E_SHOT rtc syncToGPS boolean dateTime string Should accept any reasonable time string e g Wed 21 Feb 2018 16 17 13 GMT logging enable boolean Global logging enable disable bytesWritten number This attribute is read only fileSize number This attribute is read only fileType string This attribute is read only LINEAR or CIRCULAR groupSensorReadingsEnable boolean Try to group log entries with a single ...

Page 33: ... IoT functions minBatteryThreshold number Don t activate IoT unless min battery level threshold is met cellular enable boolean Enable disable the cellular module connectionPriority number 0 highest 10 lowest for handling radio access contentions default 0 connectionMode string 2G 3G AUTO logFilter string List of logging tag names for sending of outgoing logging data statusFilter string List of sta...

Page 34: ...pack into each transmit message minUpdates number Min number of updates before transmitting 1 at least 1 update 2 at least 2 updates etc 0 not permitted minInterval number Don t try to send a message if any other radio technology has transmitted within the prior interval seconds maxInterval number Max allowed interval in seconds between updates This overrides minUpdates setting and forces a transm...

Page 35: ...ts h help Show this help message and exit version Display application version number debug Turn on debug trace level cert_path CERT_PATH Path for where all certificates and keys shall be stored default is certificates namespace NAMESPACE Namespace for creating IoT objects default is arribada install admin Installation setup of IoT infrastructure need only be done once uninstall admin Uninstall a p...

Page 36: ..._NAME admin Send a logging bin file to THING_NAME file is passed in file option download_dataset DATASET_NAME any Download a csv file for the given dataset name on the AWS IoTAnalytics server update_dataset DATASET_NAME admin Force an update of the given dataset name on the AWS IoTAnalytics server list_datasets any Obtain a list of available data sets on the AWS IoTAnalytics server data DATA Use f...

Page 37: ...Page 37 of 42 update on THING_NAME file FILE Provides a file name to support other operations 7 7 2 tracker_config Arribada Horizon ARTIC R2 Developer s Kit User Manual ...

Page 38: ...d the current battery level and display status read the current device status and display erase erase the current RAM configuration to defaults erase_log erase the current log file in flash memory create_log LOG_TYPE create a log file of the specified type LINEAR CIRCULAR reset RESET_TYPE reset the system with the specified type CPU FLASH test_mode TEST_MODE apply test mode flash as a comma separa...

Page 39: ...ificate to store in secure area on the device key filename mandatory filename of the device private key to store in secure area on the device debug enable debug level trace for AT command debugging verify check if all the device 7 7 4 gps_almanac usage gps_almanac h serial SERIAL baud BAUD ble_addr BLUETOOTH_ADDR file FILE debug serial local serial port for bridging via local serial port eg dev tt...

Page 40: ...timestamp Mandatory Integer Number of seconds since the epoch last_log_file_read_pos Optional Integer The last known read position from the log file stored on the tracker device The information persists across multiple connections and is updated only by the tracker device LAST_LOG_READ_POS last_gps_fix_longitude Optional Float GPS longitude expressed as floating point LAST_GPS_LOCATION last_gps_fi...

Page 41: ...co ordinate GPS height Mandatory Float GPS height in metres GPS h_acc Mandatory Float GPS horizontal accuracy in metres GPS v_acc Mandatory Float GPS vertical accuracy in metres GPS ttff Optional Integer Time To First Fix in seconds GPS 7 8 3 Battery data set Field Name Presence Type Notes Logging Filter Enable Tag __dt Mandatory String Delta time since previous logged item thing_name Mandatory St...

Page 42: ...attery_voltage number Last battery voltage from ADC configuration_version number Last configuration version 0 N firmware_version number Last firmware version 0 N last_log_file_read_pos number Log file read seek position offset Note that the field is manipulated by the tool via the and o device_update aws_config configuraton_update firmware_update ptions It should not be set directly The field may ...

Reviews:

No comments