MeshCore Companion Radio | CLI user guide MeshCore Companion Radio CLI user guide Companion firmware V1.18.0 Use this guide to check your radio, change its settings, and find commands for Wi-Fi and supported board features. It covers the commands in the supplied reference; availability depends on your radio and the firmware installed. Entering commands Commands are case-sensitive. Type them exactly as shown. Replace placeholders such as <name> with your own value, without the angle brackets. Where options are shown as on|off, choose one word. Enter radio parameters as four comma-separated values. Settings are saved by the firmware. Reboot where indicated to apply a change. The supplied reference does not specify how to open a command interface, so use the command interface available for your device. Device information and basic settings Command What it does board Show the board manufacturer. ver Show the firmware version and build date. get name Show the node name. set name <name> Save the node name. The name must be accepted by the radio. set pin <pin> Save the Bluetooth Low Energy (BLE) PIN. Use a numeric PIN; the reply displays at least six digits. get tz.offset Show the timezone offset. set tz.offset <offset> Save an offset from 12 to +14 hours. Use whole hours; − fractional parts are discarded. reboot Restart the radio. poweroff shutdown Power off the radio. Both commands have the same effect. Example To rename your radio, enter set name Trail Radio, then get name to check the saved name. Firmware V1.18.0 • 1 MeshCore Companion Radio | CLI user guide Radio settings and airtime Check the current settings before changing them. The ranges below are the accepted command ranges; your hardware may impose additional limits. Frequency and modulation Command What it does get radio Show frequency, bandwidth, spreading factor and coding rate, in that order, separated by commas. get freq Show the frequency. There is no separate set freq command in this reference. set radio <freq>,<bw>,<sf>,<cr> Set all four radio parameters together. Reboot to apply. freq: frequency from 150 to 2500 MHz. bw: bandwidth from 7 to 500 kHz. sf: spreading factor from 5 to 12. cr: coding rate from 5 to 8. Transmit power and airtime Command What it does get tx Show transmit power. set tx <power> Set transmit power [dBm] and apply it immediately. The supplied reference gives no numeric range or unit; available values depend on the radio. Important: Does not include the gain of an on-board PA, if present. For details, check the documentation of your board. get af Show the airtime factor. set af <factor> Set the airtime factor from 0 to 9. Decimal values are accepted. get dutycycle Show the duty cycle as a percentage. set dutycycle <percent> Set a duty cycle from 1 to 100 percent. The radio replies with the resulting duty cycle. Airtime factor and duty cycle are linked: duty cycle (%) = 100 ÷ (airtime factor + 1). For example, an airtime factor of 9 corresponds to 10%. The two setter commands have different accepted ranges. Firmware V1.18.0 • 2 MeshCore Companion Radio | CLI user guide Advanced radio settings These commands adjust radio reception, delays and acknowledgement settings. Where the reference gives no range, unit or detailed explanation, this guide does not assume one. Command What it does get int.thresh set int.thresh <value> Show or set the interference threshold. Use an integer; no range is specified. get cad set cad <on|off> Show or change channel activity detection (CAD). Use on or off. get radio.rxgain set radio.rxgain <on|off> Show or change boosted receive gain. The radio attempts to apply it immediately. Error: unsupported means the radio driver cannot apply it; the preference is still saved. get rxdelay set rxdelay <value> Show or set RX delay. Accepted range: 0–20; decimals are accepted. get agc.reset.interval set agc.reset.interval <seconds> Show or set the automatic gain control (AGC) reset interval. Use whole seconds. Values are limited to 0–1020; the reply reports the rounded interval actually stored. get path.hash.mode set path.hash.mode <mode> Show or set the path hash mode. Use 0, 1 or 2. The reference does not explain the modes. get multi.acks set multi.acks <value> Show or set the multiple-acknowledgement setting. Use an integer; no range is specified. get txdelay set txdelay <value> Show or set the flood transmit delay. Accepted range: 0–2; decimals are accepted. get direct.txdelay set direct.txdelay <value> Show or set the direct transmit delay. Accepted range: 0–2; decimals are accepted. Firmware V1.18.0 • 3 MeshCore Companion Radio | CLI user guide WiFi connection These commands are available only in firmware that includes the Wi-Fi interface. Reboot after changing the network name, password or enabled state, or after clearing the credentials. Network setup and status Command What it does set wifi.ssid <ssid> Save the Wi-Fi network name (SSID). Set the password too, then reboot to apply. get wifi.ssid Show the saved network name, or (not set). set wifi.pwd <password> Save the Wi-Fi password. Reboot to apply. get wifi.pwd Show the saved password in plain text. set wifi.clear Clear both the saved network name and password. Takes no argument. Reboot to apply. set wifi.enabled <value> Save 0 to disable Wi-Fi or 1 to enable it. Reboot to apply. Other nonzero integer values also enable it. get wifi.enabled Show the saved enabled state: 0 or 1. get wifi.status Show connected or disconnected. get wifi.ip Show the local IP address, or (not connected). Example setup Replace the example network name and password with your own, then enter these commands in order: set wifi.ssid MyNetwork set wifi.pwd MyPassword set wifi.enabled 1 reboot get wifi.status get wifi.ip Password visibility: get wifi.pwd displays the actual password. Keep this in mind when sharing command output. Firmware V1.18.0 • 4 MeshCore Companion Radio | CLI user guide Front end amplifier controls Some boards have a LoRa front-end module (FEM) with a low-noise amplifier (LNA) for reception or a power amplifier (PA) for transmission. These controls are separate from radio.rxgain. Gain commands Command What it does get radio.fem.rxgain Show the receive amplifier state as on or off, or report Error: unsupported. set radio.fem.rxgain <on|off> Apply the receive amplifier state immediately and save it if successful. get radio.fem.txgain Show the transmit amplifier gain state as on or off, or report Error: unsupported. set radio.fem.txgain <on|off> Apply the transmit amplifier gain state immediately and save it if successful. Use on or off. An invalid state returns Error: state must be on or off. An unsupported control returns Error: unsupported. If applying a setting fails, the saved setting is not changed. Board availability Board variant Receive gain Transmit gain heltec_t096 If LNA control is available Not available heltec_tracker_v2 If LNA control is available Not available heltec_v4 If LNA control is available Not available heltec_v4_r8 If LNA control is available Not available station_g3_esp32 If LNA control is available If PA gain control is available wio-tracker-l1-1w Always reports unsupported Supported Board variant names are included to help identify which controls your device supports. Firmware V1.18.0 • 5 MeshCore Companion Radio | CLI user guide LilyGo T Beam 1W fan These commands apply to the LilyGo T-Beam 1W board variant lilygo_tbeam_1w. They control the fan mode and temperature thresholds. Command What it does get fan Show the fan mode, temperature in °C, actual fan state and transmit cooldown. An implausible sensor reading appears as n/a. The actual state appears as fan=on or fan=off; cd=<seconds>s is the transmit cooldown. set fan <on|off|auto> Save and apply the mode. on turns the fan on unless the board is stopped; off turns it off; auto immediately updates automatic fan control. The mode must match exactly. set fan.lo <temperature> Save and apply the lower threshold in °C. Use a whole number from 0 to 100, strictly below the current upper threshold. set fan.hi <temperature> Save and apply the upper threshold in °C. Use a whole number strictly above the current lower threshold, and no higher than 120. Entering temperature thresholds Use decimal whole numbers only, with no units, extra characters or trailing spaces. Fan settings take effect only if the setting is saved successfully; otherwise the radio returns an error. There are no separate get fan.lo or get fan.hi commands in the supplied reference. Example To enable automatic fan control, enter set fan auto. Then enter get fan to check the mode, temperature, actual fan state and transmit cooldown. About this guide Extracted from the source code of the MeshCore Companion Radio firmware V1.18.0 using OpenAI Codex. Formatted as a user guide by ChatGPT. The GPT-6.1 Sol Light model was used for both tasks. Disclaimer: AI generated content may be inaccurate, use at your own risk. Firmware V1.18.0 • 6