Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RadioConfig_UserPreferences

see software design for more information on these preferences

generated

from protobuf message RadioConfig.UserPreferences

Hierarchy

  • RadioConfig_UserPreferences

Index

Properties

chargeCurrent

chargeCurrent: ChargeCurrent

Sets the current of the battery charger

generated

from protobuf field: ChargeCurrent charge_current = 16;

debugLogEnabled

debugLogEnabled: boolean

By default we turn off logging as soon as an API client connects (to keep shared serial link quiet). Set this to true to leave the debug log outputting even when API is active.

generated

from protobuf field: bool debug_log_enabled = 101;

environmentalMeasurementPluginDisplayFarenheit

environmentalMeasurementPluginDisplayFarenheit: boolean

We'll always read the sensor in Celsius, but sometimes we might want to display the results in Farenheit as a "user preference".

generated

from protobuf field: bool environmental_measurement_plugin_display_farenheit = 145;

environmentalMeasurementPluginMeasurementEnabled

environmentalMeasurementPluginMeasurementEnabled: boolean

Preferences for the EnvironmentalMeasurement Plugin FIXME - Move this out of UserPreferences and into a section for plugin configuration. Enable/Disable the environmental measurement plugin measurement collection

generated

from protobuf field: bool environmental_measurement_plugin_measurement_enabled = 140;

environmentalMeasurementPluginReadErrorCountThreshold

environmentalMeasurementPluginReadErrorCountThreshold: number

Sometimes sensor reads can fail. If this happens, we will retry a configurable number of attempts, each attempt will be delayed by the minimum required refresh rate for that sensor

generated

from protobuf field: uint32 environmental_measurement_plugin_read_error_count_threshold = 142;

environmentalMeasurementPluginRecoveryInterval

environmentalMeasurementPluginRecoveryInterval: number

Sometimes we can end up with more than read_error_count_threshold failures. In this case, we will stop trying to read from the sensor for a while. Wait this long until trying to read from the sensor again

generated

from protobuf field: uint32 environmental_measurement_plugin_recovery_interval = 144;

environmentalMeasurementPluginScreenEnabled

environmentalMeasurementPluginScreenEnabled: boolean

Enable/Disable the environmental measurement plugin on-device display

generated

from protobuf field: bool environmental_measurement_plugin_screen_enabled = 141;

environmentalMeasurementPluginSensorPin

environmentalMeasurementPluginSensorPin: number

Specify the peferred GPIO Pin for sensor readings

generated

from protobuf field: uint32 environmental_measurement_plugin_sensor_pin = 147;

environmentalMeasurementPluginSensorType

environmentalMeasurementPluginSensorType: DHT11

Specify the sensor type

generated

from protobuf field: RadioConfig.UserPreferences.EnvironmentalMeasurementSensorType environmental_measurement_plugin_sensor_type = 146;

environmentalMeasurementPluginUpdateInterval

environmentalMeasurementPluginUpdateInterval: number

Interval in seconds of how often we should try to send our measurements to the mesh

generated

from protobuf field: uint32 environmental_measurement_plugin_update_interval = 143;

extNotificationPluginActive

extNotificationPluginActive: boolean
generated

from protobuf field: bool ext_notification_plugin_active = 129;

extNotificationPluginAlertBell

extNotificationPluginAlertBell: boolean
generated

from protobuf field: bool ext_notification_plugin_alert_bell = 131;

extNotificationPluginAlertMessage

extNotificationPluginAlertMessage: boolean
generated

from protobuf field: bool ext_notification_plugin_alert_message = 130;

extNotificationPluginEnabled

extNotificationPluginEnabled: boolean

Preferences for the ExternalNotificationPlugin FIXME - Move this out of UserPreferences and into a section for plugin configuration.

generated

from protobuf field: bool ext_notification_plugin_enabled = 126;

extNotificationPluginOutput

extNotificationPluginOutput: number
generated

from protobuf field: uint32 ext_notification_plugin_output = 128;

extNotificationPluginOutputMs

extNotificationPluginOutputMs: number
generated

from protobuf field: uint32 ext_notification_plugin_output_ms = 127;

factoryReset

factoryReset: boolean

This setting is never saved to disk, but if set, all device settings will be returned to factory defaults. (Region, serial number etc... will be preserved)

generated

from protobuf field: bool factory_reset = 100;

fixedPosition

fixedPosition: boolean

If set, this node is at a fixed position. We will generate GPS position updates at the regular interval, but use whatever the last lat/lon/alt we have for the node. The lat/lon/alt can be set by an internal GPS or with the help of the app.

generated

from protobuf field: bool fixed_position = 39;

frequencyOffset

frequencyOffset: number

This parameter is for advanced users with advanced test equipment, we do not recommend most users use it. A frequency offset that is added to to the calculated band center frequency. Used to correct for crystal calibration errors.

generated

from protobuf field: float frequency_offset = 41;

gpsAttemptTime

gpsAttemptTime: number

How long should we try to get our position during each gps_update_interval attempt? (in seconds) Or if zero, use the default of 30 seconds. If we don't get a new gps fix in that time, the gps will be put into sleep until the next gps_update_rate window.

generated

from protobuf field: uint32 gps_attempt_time = 36;

gpsOperation

gpsOperation: GpsOperation

How the GPS hardware in this unit is operated. Note: This is independent of how our location is shared with other devices. For that see LocationSharing

generated

from protobuf field: GpsOperation gps_operation = 33;

gpsUpdateInterval

gpsUpdateInterval: number

How often should we try to get GPS position (in seconds) when we are in GpsOpMobile mode? or zero for the default of once every 30 seconds or a very large value (maxint) to update only once at boot.

generated

from protobuf field: uint32 gps_update_interval = 34;

ignoreIncoming

ignoreIncoming: number[]

If true, radio should not try to be smart about what packets to queue to the phone bool keep_all_packets = 101; If true, we will try to capture all the packets sent on the mesh, not just the ones destined to our node. bool promiscuous_mode = 102; For testing it is useful sometimes to force a node to never listen to particular other nodes (simulating radio out of range). All nodenums listed in ignore_incoming will have packets they send droped on receive (by router.cpp)

generated

from protobuf field: repeated uint32 ignore_incoming = 103;

isLowPower

isLowPower: boolean

If set, we are powered from a low-current source (i.e. solar), so even if it looks like we have power flowing in we should try to minimize power consumption as much as possible. YOU DO NOT NEED TO SET THIS IF YOU'VE set is_router (it is implied in that case).

generated

from protobuf field: bool is_low_power = 38;

isRouter

isRouter: boolean

Are we operating as a router. Changes behavior in the following ways: The device will only sleep for critically low battery level (i.e. always tries to stay alive for the mesh) In the future routing decisions will preferentially route packets through nodes with this attribute (because assumed good line of sight)

generated

from protobuf field: bool is_router = 37;

locationShare

locationShare: LocationSharing

How our location is shared with other nodes (or the local phone)

generated

from protobuf field: LocationSharing location_share = 32;

lsSecs

lsSecs: number

Power management state machine option. See power management for details. 0 for default of 3600

generated

from protobuf field: uint32 ls_secs = 10;

meshSdsTimeoutSecs

meshSdsTimeoutSecs: number

Power management state machine option. See power management for details. 0 for default of two hours, MAXUINT for disabled

generated

from protobuf field: uint32 mesh_sds_timeout_secs = 8;

minWakeSecs

minWakeSecs: number

Power management state machine option. See power management for details. 0 for default of 10 seconds

generated

from protobuf field: uint32 min_wake_secs = 11;

mqttDisabled

mqttDisabled: boolean

If a meshtastic node is able to reach the internet it will normally attempt to gateway any channels that are marked as is_uplink_enabled or is_downlink_enabled. But if this flag is set, all MQTT features will be disabled and no servers will be contacted.

generated

from protobuf field: bool mqtt_disabled = 43;

mqttServer

mqttServer: string

The server to use for our MQTT global message gateway feature. If not set, the default server will be used

generated

from protobuf field: string mqtt_server = 42;

phoneSdsTimeoutSec

phoneSdsTimeoutSec: number

Power management state machine option. See power management for details. 0 for default of two hours, MAXUINT for disabled

generated

from protobuf field: uint32 phone_sds_timeout_sec = 7;

phoneTimeoutSecs

phoneTimeoutSecs: number

Power management state machine option. See power management for details. 0 for default of 15 minutes IMPORTANT NOTE FOR DEVICE CLIENTS: YOU MUST SEND SOME SORT OF PACKET TO THE PHONE AT LEAST THIS OFTEN OR THE DEVICE WILL DECIDE YOU ARE GONE!

generated

from protobuf field: uint32 phone_timeout_secs = 6;

positionBroadcastSecs

positionBroadcastSecs: number

We should send our position this often (but only if it has changed significantly) Defaults to 15 minutes

generated

from protobuf field: uint32 position_broadcast_secs = 1;

rangeTestPluginEnabled

rangeTestPluginEnabled: boolean

Preferences for the RangeTestPlugin FIXME - Move this out of UserPreferences and into a section for plugin configuration.

generated

from protobuf field: bool range_test_plugin_enabled = 132;

rangeTestPluginSave

rangeTestPluginSave: boolean
generated

from protobuf field: bool range_test_plugin_save = 134;

rangeTestPluginSender

rangeTestPluginSender: number
generated

from protobuf field: uint32 range_test_plugin_sender = 133;

region

region: RegionCode

The region code for my radio (US, CN, EU433, etc...)

generated

from protobuf field: RegionCode region = 15;

screenOnSecs

screenOnSecs: number

Power management state machine option. See power management for details. 0 for default of one minute

generated

from protobuf field: uint32 screen_on_secs = 5;

sdsSecs

sdsSecs: number

Power management state machine option. See power management for details. 0 for default of one year

generated

from protobuf field: uint32 sds_secs = 9;

sendOwnerInterval

sendOwnerInterval: number

Send our owner info at least this often (also we always send once at boot - to rejoin the mesh)

generated

from protobuf field: uint32 send_owner_interval = 2;

serialDisabled

serialDisabled: boolean

If set, this will disable the SerialConsole by not initilizing the StreamAPI

generated

from protobuf field: bool serial_disabled = 40;

serialpluginEcho

serialpluginEcho: boolean
generated

from protobuf field: bool serialplugin_echo = 121;

serialpluginEnabled

serialpluginEnabled: boolean

Preferences for the SerialPlugin FIXME - Move this out of UserPreferences and into a section for plugin configuration.

generated

from protobuf field: bool serialplugin_enabled = 120;

serialpluginMode

serialpluginMode: number
generated

from protobuf field: uint32 serialplugin_mode = 125;

serialpluginRxd

serialpluginRxd: number
generated

from protobuf field: uint32 serialplugin_rxd = 122;

serialpluginTimeout

serialpluginTimeout: number
generated

from protobuf field: uint32 serialplugin_timeout = 124;

serialpluginTxd

serialpluginTxd: number
generated

from protobuf field: uint32 serialplugin_txd = 123;

storeForwardPluginEnabled

storeForwardPluginEnabled: boolean

Preferences for the StoreForwardPlugin FIXME - Move this out of UserPreferences and into a section for plugin configuration. (was 136)

generated

from protobuf field: bool store_forward_plugin_enabled = 148;

storeForwardPluginRecords

storeForwardPluginRecords: number
generated

from protobuf field: uint32 store_forward_plugin_records = 137;

waitBluetoothSecs

waitBluetoothSecs: number

Power management state machine option. See power management for details. 0 for default of 1 minute

generated

from protobuf field: uint32 wait_bluetooth_secs = 4;

wifiApMode

wifiApMode: boolean

If set, the node will operate as an AP (and DHCP server), otherwise it will be a station

generated

from protobuf field: bool wifi_ap_mode = 14;

wifiPassword

wifiPassword: string

If set, will be use to authenticate to the named wifi

generated

from protobuf field: string wifi_password = 13;

wifiSsid

wifiSsid: string

If set, this node will try to join the specified wifi network and acquire an address via DHCP

generated

from protobuf field: string wifi_ssid = 12;

Generated using TypeDoc