# Companion CLI Since version 1.18 meshcore companion radio firmware has a CLI interface, which can be accessed locally (through companion radio protocol) or remotely via the network. ## Navigation - [Operational](#operational) - [Configuration](#configuration) - [System](#system) - [Radio](#radio) - [GPS](#gps) - [BLE](#ble) - [Wifi](#wifi) - [UI](#ui) ## Operational ### Reboot the node **Usage:** - `reboot` **Note:** No reply is sent. --- ### Power-off the node **Usage:** - `poweroff`, or - `shutdown` **Note:** No reply is sent. --- ## Configuration ### System #### View or change this node's name **Usage:** - `get name` - `set name ` **Parameters:** - `name`: Node name **Set by build flag:** `ADVERT_NAME` **Default:** Varies by board **Note:** Advertised names can use up to 23 bytes when location is included and 31 bytes otherwise. Emoji and Unicode characters may take more than one byte. Names that exceed the available advert space are truncated at a valid UTF-8 code point boundary. --- #### View this node's firmware version **Usage:** `ver` --- #### Configure this node's timezone **Usage:** - `set tz.offset ` - `get tz.offset` **Parameters:** - `offset`: float value of the offset in hours --- #### Fine-tune the battery reading **Usage:** - `get adc.multiplier` - `set adc.multiplier ` **Parameters:** - `value`: ADC multiplier (0.0-10.0) **Default:** `0.0` (value defined by board) **Note:** Returns "Error: unsupported" if the board doesn't support it. Same command as on repeaters, for boards whose battery divider resistors vary (e.g. DIY ProMicro / Faketec). --- ### Radio Radio parameters are common to all roles and handled by `CommonRadioPrefs`. #### View or change this node's radio parameters **Usage:** - `get radio` - `set radio ,,,` **Parameters:** - `freq`: Frequency in MHz - `bw`: Bandwidth in kHz - `sf`: Spreading factor (5-12) - `cr`: Coding rate (5-8) **Set by build flag:** `LORA_FREQ`, `LORA_BW`, `LORA_SF`, `LORA_CR` **Default:** `869.618,62.5,8,5` **Note:** Requires reboot to apply --- #### View or change this node's transmit power **Usage:** - `get tx` - `set tx ` **Parameters:** - `dbm`: Power level in dBm (1-22) **Set by build flag:** `LORA_TX_POWER` **Default:** Varies by board **Notes:** This setting only controls the power level of the LoRa chip. Some nodes have an additional power amplifier stage which increases the total output. Refer to the node's manual for the correct setting to use. **Setting a value too high may violate the laws in your country.** --- #### View or change this node's frequency **Usage:** - `get freq` - `set freq ` **Parameters:** - `frequency`: Frequency in MHz **Default:** `869.618` **Note:** Requires reboot to apply **Serial Only:** `set freq ` --- ### GPS #### View GPS state **Usage:** - `gps` **Note:** Reports the requested state, receiver activity, last-fix status (last fix gives number of sats and how long ago was the fix), and mode. In periodic mode, `waiting` means the receiver is off between acquisitions; the last fix remains available. `off(hw)` means a hardware GPS switch is off. --- #### Change GPS state **Usage:** - `gps ` **Parameters:** - `state`: `on`|`off` --- #### View or change the GPS acquisition period **Usage:** - `gps period` - `gps period ` **Parameters:** - `value`: `0` for continuous tracking, or a period. The value can be postfixed with `s`, `m`, `h` or `d` to specify the unit (seconds by default). **Note:** A periodic acquisition stops after receiving a valid fix, then resumes after the configured period. --- #### View the last GPS fix **Usage:** - `gps fix` **Output:** - `> Fix (n sat): , `: the GPS currently has a fix. - `> Last fix ago (n sat)[, acq