Diagnostic menu reference
Available commands
Brief description of the commands that a user can execute manually from a serial terminal on an RBRcervello.
RBRcervello Menu.
These are the available commands to manage RBRcervello
disable Disable deployment.
status Provide a general overview or detailed information on
controller and instruments.
diagnose Diagnostics for MLM and telemetry.
transparent-link Establish a transparent link to an instrument
serial port.
config-check Print the current configuration of a specific RBR
subsystem.
edit-config Edit the current configuration of a specific
RBR subsystem.
set-instrument-clock RBR instrument clock sync.
set-cervello-clock RBRcervello clock setter.
cervello-clock RBRcervello clock checker.
scrub-controller Clear all data stored in the SD card.
scrub-instrument RBR instrument scrubber.
enable Enable deployment according to internal configuration
files.
reboot-controller Reboot system as if it had entered deep-sleep and
waken up.
help Show this menu.
status
Name
status - Status checker for RBRcervello and RBRcervata
Synopsis
Provide an overview on the system status.
status [-h|--help] | [-v|--version]
status [-p|--progress]
Description
Prints a status overview of the controller including battery information, storage usage, connected instruments status.
Options
-h, --help
Display this help message and exit.
-v, --version
Output version information and exit.
-p, --progress
Show progress bars for downloads.
Examples
status
RBRcervata
Serial number: 234567
Part number: 0010423
Cervello firmware version: 1.014
Storage used : 33MB
Storage remaining: 120GB
Storage size : 120GB
Cervello status: logging
Cervello internal battery (V): 11.95
Cervello external battery (V): 9.05
Instrument 01: logging
Instrument 01 internal battery (V): 6.00
Instrument 01 external battery (V): 11.49
Instrument 02: logging
Instrument 02 internal battery (V): 6.00
Instrument 02 external battery (V): 11.52
Download remaining: 1716B
status -p
RBRcervata
Serial number: 234567
Part number: 0010423
Cervello firmware version: 1.014
Storage used : 33MB
Storage remaining: 120GB
Storage size : 120GB
Cervello status: logging
Cervello internal battery (V): 11.95
Cervello external battery (V): 9.05
Instrument 01: logging
Instrument 01 internal battery (V): 6.00
Instrument 01 external battery (V): 11.49
Instrument 02: logging
Instrument 02 internal battery (V): 6.00
Instrument 02 external battery (V): 11.52
Download remaining: 1556B
Instrument 01: waiting
Remaining= 0B
[=========================] 100%
Instrument 02: downloading
Remaining= 770B
[============------------------------] 50%
config-check
Name
config-check - RBR configuration checker.
Synopsis
RBR configuration checker.
config-check [-h|--help] | [-v|–version]
config-check [-c|--config-file] [device]
Description
Prints the current configuration of a specific RBR subsystem.
Options
-h, --help
Display this help message and exit.
-v, --version
Output version information and exit.
-c, --config-file [device]
Show configuration file.
Where 'device' is the device of which configuration will be shown.
The supported devices are the following:
instrument[##] prints its corresponding deployment.json
cervello prints user.ini
Examples
config-check -c cervello
[metadata]
# The user.ini specification version to which this file will conform.
version = 2.0
[controller]
# How frequently to record the data controller battery level.
battery_period = 600 # 10 minutes
# Whether the data controller should enter deep sleep whenever it's finished
# downloading from the logger.
deep_sleep = true
# How long to stay in deep sleep before checking the logger for data again.
deep_sleep_duration = 21600 # 6 hours
#The number of seconds after the cervello clock sync under which the cervello clock is
#considered good to be used as a synchronization source .
clock_sync_timeout = 43200 # 12 hours
[gps]
# Whether position retrieval via GPS is enabled.
enabled = false
.
.
.
[processing]
# Whether data processing for telemetry is enabled or not.
enabled = false
[telemetry]
# Whether telemetry is enabled or not.
enabled = false
scrub-instrument
Name
scrub-instrument - memory eraser for instruments
Synopsis
RBR instrument scrubber.
scrub-instrument [instrument-number]
scrub-instrument [-h] | [-a]
Description
scrub-instrument provides the means for clearing the internal memory of an instrument connected to the system.
Options
-h, --help
Display this help message and exit.
-v, --version
Output version information and exit.
instrument-number
Numeric id of the instrument to be erased.
-a
Erase all instruments.
Examples
scrub-instrument 01
Clearing memory...
Instrument 01: success
scrub-instrument -a
Clearing memory...
Instrument 01: success
Instrument 02: success
scrub-controller
Name
scrub-controller - clears the system's storage.
Synopsis
Clear all data stored in the SD card.
scrub-controller [-h] | [-f|--format]
Description
Stops any running service, clears the memory and restarts all the services.
Options
-h, --help
Display this help message and exit.
-v, --version
Output version information and exit.
-f| --format
(Not available for Cervata)
Formats the SD card in the proper ext4 filesystem
and initializes the folder structure.
set-cervello-clock
Name
set-cervello-clock - sets internal clock.
Synopsis
RBRcervello clock setter.
set-cervello-clock [string-formatted-date]
set-cervello-clock [-h]
Description
set-cervello-clock sets instrument clock and saves a previous and
new time in every Ruskin Database file involved, system's and intrument's
Options
-h, --help
Display this help message and exit.
-v, --version
Output version information and exit.
Examples
set-cervello-clock '2014-12-25T12:34:56'
Previous internal time: '2014-12-25T10:12:00'
New internal time: '2014-12-25T12:34:56'
set-instrument-clock
Name
set-instrument-clock - set instrument clock based on internal clock.
Synopsis
Set instrument clock with the system's time as reference.
set-instrument-clock [-h] | [-a|--all]
set-instrument-clock [instrument-number]
Description
set-instrument-clock sets instrument clock and saves a previous and
new time in every Ruskin Database file involved, system's and intrument's
Options
-h, --help
Display this help message and exit.
-v, --version
Output version information and exit.
-a |--all
Set clock on all connected instruments.
instrument-number
Numeric id of the instrument to be time synchronized.
Examples
set-instrument-clock 01
enable
Name
enable
Synopsis
Enable deployment according to internal configuration files.
enable [-h]
Description
Start deployment, configure instruments and enable them to start logging. Deletes any stopping flag for the deployment, whenever the system reboots, the deployment behaviour will continue.
Options
-h, --help
Display this help message and exit.
-v, --version
Output version information and exit.
disable
Name
disable
Synopsis
Disable deployment.
disable [-h]
Description
Stop deployment, disable instruments download their data and generate a persistent flag to prevent the deployment to start in future boot cycles.
Options
-h, --help
Display this help message and exit.
-v, --version
Output version information and exit.
reboot-controller
Name
reboot-controller - Gracefully reboot the system
Synopsis
Reboot system as if it had entered deep-sleep and waken up.
reboot-controller [-h]
Description
Gracefully stop all internal services and reboot the system. Useful
for testing deployment behaviour.
Options
-h, --help
Display this help message and exit.
-v, --version
Output version information and exit.
edit-config
Name
edit-config - edit configuration files.
Synopsis
Edit the current configuration of a specific RBR device.
edit-config [-n|–new-file] | [-c|--config-file] device
edit-config [-h]
Description
Edit the current configuration of a specific RBR device. It uses 'nano' as its editor.
Options
-h, --help
Display this help message and exit.
-v, --version
Output version information and exit.
-c, --config-file [device]
Where 'device' is the device of which configuration will be shown.
The supported devices are the following:
* instrument[##] prints its corresponding deployment.json
eg. "instrument01"
* cervello prints user.ini
-n, --new-file
Sets an empty file for copy/paste a new config file.
Examples
edit-config -c instrument01
edit-config -c cervello
cervello-clock
Name
cervello-clock - check Cervello clock
Synopsis
RBRcervello clock checker
cervello-clock [-h|--help]
Description
Check system's clock and its latest synchronization
Options
-h, --help
Display this help message and exit.
-v, --version
Output version information and exit.
Examples
cervello-clock
Last time sync: '2021-06-28 15:31:00'
Current internal time: '2021-06-29 11:54:24'