GA1 Device parameter list

The following parameters are supported in the GA1 firmware release.

Device configuration templates are available to facilitate common device configurations.

Non-volatile parameters

The following parameters are modifiable and saved to non-volatile memory.

Name id type min /
min length		 max /
max length		 Default Enumeration Desc
active_mode 13 bool 0 1 1 0 : Inactive (shelf mode)
1 : Active (sensor enabled)		 Shelf mode allows the sensor to be placed in an inactive low-power mode.
advertising_duration 4 uint16_t 0 65535 15000 - Advertising duration of an event in milliseconds.

Must be 4x greater than the Interval.
advertising_interval 3 uint16_t 500 10000 1000 - Advertising Interval in milliseconds.
analog_input_1_type 34 uint8_t 0 7 0 0 : Unused
2 : Current 4mA to 20mA
3 : Pressure
4 : Ultrasonic
5 : AC Current 20A
6 : AC Current 150A
7 : AC Current 500A		 Analog Input Channel 1 (AIN1) configuration.

If changing a pressure sensor port any active pressure sensor ports must be first set to 0.
analog_input_2_type 35 uint8_t 0 7 0 0 : Unused
2 : Current 4mA to 20mA
3 : Pressure
4 : Ultrasonic
5 : AC Current 20A
6 : AC Current 150A
7 : AC Current 500A		 Analog Input Channel 2 (AIN2) configuration.

If changing a pressure sensor port any active pressure sensor ports must be first set to 0.
analog_input_3_type 36 uint8_t 0 7 0 0 : Unused
2 : Current 4mA to 20mA
3 : Pressure
4 : Ultrasonic
5 : AC Current 20A
6 : AC Current 150A
7 : AC Current 500A		 Analog Input Channel 3 (AIN3) configuration.

If changing a pressure sensor port any active pressure sensor ports must be first set to 0.
analog_input_4_type 37 uint8_t 0 7 0 0 : Unused
2 : Current 4mA to 20mA
3 : Pressure
4 : Ultrasonic
5 : AC Current 20A
6 : AC Current 150A
7 : AC Current 500A		 Analog Input Channel 4 (AIN4) configuration.

If changing a pressure sensor port any active pressure sensor ports must be first set to 0.
analog_sense_interval 45 uint32_t 0 86400 60 - Analog Sense interval in seconds.

Determines the frequency at which analog sensor measurments are performed.
baud_rate 121 uint32_t - - 115200 - Baud rate for console uart.

Requires a reboot to take effect.
config_type 18 uin8_t 0 6 0 0 : Not Configured
1 : Analog
2: Digital
3 : Temperature
4 : Ultrasonic & Pressure
 Predetermined configurations (modes of operation).
device_id 152 string 0 64 ”” - Unique identifier for the device.

When firmware boots, if the value is blank (the default value), the firmware will set a unique value for the device using BLE MAC address, IMEI, or some similar value.
disable_flow_control 120 bool 0 1 0 0 : Flow Control Enabled
1 : Flow Control Disabled		 When true flow control is disabled on the console UART.

Requires a reboot to take effect.
dm_cnx_delay 150 uint16_t 0 600 0 - Delay (in seconds) before connecting to DM server.
dm_key_path 125 string 1 32 “/lfs1/enc/dm/key” - The path to the key store for DM authentication.
dm_trust_path 124 string 1 32 “/lfs1/dm/trust” - The path to the trust store for DM authentication.
event_filter_flags 116 uin32_t 0 2097151 2097151 Bit 0 : Temperature on TH1
Bit 1 : Temperature on TH2
Bit 2 : Temperature on TH3
Bit 3 : Temperature on TH4
Bit 8 : Current on AIN1
Bit 9 : Current on AIN2
Bit 10 : Current on AIN3
Bit 11 : Current on AIN4
Bit 12 : Ultrasonic
Bit 13 : Pressure 1
Bit 14 : Pressure 2
Bit 15 : Tamper Switch
Bit 16 : Magnet Sense
Bit 17 : Battery Good
Bit 18 : Battery Bad		 Filter to limit Bluetooth advertisement events.

Clearing the appropriate bit prevents that event type being broadcast in BLE advertisements.
factory_load_path 151 string 1 32 “/lfs1/enc/factory_load.txt” - Path for factory settings that can be restored with attribute load.
fs_trust_path 126 string 1 32 “/lfs1/fs/trust” - The path to the trust store for firmware and file service authentication.
fs_key_path 127 string 1 32 “/lfs1/enc/fs/key” - The path to the key store for firmware and file service authentication.
load_path 113 string 0 32 “/lfs1/enc/attr_load.txt” - Absolute file name for load parameters command.
location 2 string 0 32 - - Device Location tag text.
log_on_boot 118 bool 0 1 0 0 : Disabled
1 : Enabled		 When set to false, logging output will be disabled when the firmware starts.
lwm2m_bootstrap 135 bool 0 1 0 0 : Disabled Bootstrap
1 : Enabled		 Enables bootstrap functionality.
lwm2m_endpoint 131 string 1 64 “my_device” - Endpoint name to identify the device.
lwm2m_fup_proxy_srv 148 string 11 255 “coaps://coap-proxy.salticidae.net:5684” - Firmware update proxy server.
lwm2m_fw_ver 140 string 1 32 “0.0.0” - Device firmware version.
lwm2m_hw_ver 144 string 1 32 “0.0.0” - Device hardware version.
lwm2m_mfg 137 string 1 32 “Laird Connectivity” - Device manufacturer.
lwm2m_mn 138 string 1 32 “model” - Device model number.
lwm2m_psk 134 uint8_t array 16 16 { 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f } - Pre-shared key.
lwm2m_psk_id 133 string 1 64 “my_device” - PSK ID.
lwm2m_security 132 uint8_t 0 4 3 0 : PSK
1 : RPK
2 : CERT
3 : None
4 : CERT EST		 LwM2M Security mode.
lwm2m_server_url 130 string 1 32 “coap://leshan.eclipseprojects.io:5683” - Server URL to connect to.
lwm2m_short_id 136 uint16_t 1 65534 1 - short_server_id This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client.

This Resource MUST be set when the Bootstrap-Server Resource has a value of ‘false’.
lwm2m_sn 139 string 1 64 “serial_number” - Device serial number.
lwm2m_sw_ver 143 string 1 32 “0.0.0” - Device software version.
network_id 16 uint16_t 0 65535 0 - Network Id used in advertisement.
p2p_key_path 129 string 1 32 “/lfs1/enc/p2p/key” - The path to the key store for peer-to-peer authentication.
p2p_trust_path 128 string 1 32 “/lfs1/p2p/trust” - The path to the trust store for peer-to-peer authentication.
power_sense_interval 5 uint32_t 0 86400 0 - Power Sense interval in seconds.
sensor_name 1 string 0 23 - - Sensor Name used by the device.
sh_offset 44 float - - - - Steinhart-Hart Temperature Equation offset.
shell_password 156 string 4 32 “zephyr” - Password to login and use the shell.
shell_session_timeout 157 uint8_t 0 255 5 - Time before a login session will expire (in minutes).

Set to 0 to disable.
smp_auth_req 154 bool 0 1 0 0 : All SMP services available
1 : SMP authentication required before accessing any SMP services		 SMP authentication option.
smp_auth_timeout 155 uint32_t 0 86400 300 - SMP authentication will time out after a lapse in SMP commands lasting this number of seconds.
tel_key_path 123 string 1 32 “/lfs1/enc/tel/key” - The path to the key store for telemetry authentication.
tel_trust_path 122 string 1 32 “/lfs1/tel/trust” - The path to the trust store for telemetry authentication.
temperature_sense_interval 6 uint32_t 0 86400 60 - Temperature Sense interval in seconds.

Determines the frequency at which thermistor measurements are made.
therm_1_coefficient_a 47 float - - - - Thermistor on TH1 Steinhart-Hart temperature equation coefficient A.
therm_1_coefficient_b 51 float - - - - Thermistor on TH1 Steinhart-Hart temperature equation coefficient B.
therm_1_coefficient_c 55 float - - - - Thermistor on TH1 Steinhart-Hart temperature equation coefficient C.
therm_2_coefficient_a 48 float - - - - Thermistor on TH2 Steinhart-Hart temperature equation coefficient A.
therm_2_coefficient_b 52 float - - - - Thermistor on TH2 Steinhart-Hart temperature equation coefficient B.
therm_2_coefficient_c 56 float - - - - Thermistor on TH2 Steinhart-Hart temperature equation coefficient C.
therm_3_coefficient_a 49 float - - - - Thermistor on TH3 Steinhart-Hart temperature equation coefficient A.
therm_3_coefficient_b 53 float - - - - Thermistor on TH3 Steinhart-Hart temperature equation coefficient B.
therm_3_coefficient_c 57 float - - - - Thermistor on TH3 Steinhart-Hart temperature equation coefficient C.
therm_4_coefficient_a 50 float - - - - Thermistor on TH4 Steinhart-Hart temperature equation coefficient A.
therm_4_coefficient_b 54 float - - - - Thermistor on TH4 Steinhart-Hart temperature equation coefficient B.
therm_4_coefficient_c 58 float - - - - Thermistor on TH4 Steinhart-Hart temperature equation coefficient C.
thermistor_config 21 uint8_t 0 15 0 Bit 0 : Thermistor on TH1
Bit 1 : Thermistor on TH2
Bit 2 : Thermistor on TH3
Bit 3 : Thermistor on TH4		 Bitmask representing Thermistor Input enable states.
tx_power 15 int8_t -40 8 0 - Bluetooth Tx Power (dBm).

Volatile parameters

The following parameters are modifiable with the values not persisting following device resets.

Name id type min /
min length		 max /
max length		 Default Enumeration Desc
adc_analog_sensor_simulated 62 bool 0 1 0 0 : Disabled
1 : Enabled		 Enables simulated Analog Sensor ADC counts.
adc_analog_sensor_simulated_counts 63 int16_t 0 4095 0 - Simulated counts for Analog Sensor ADC channel.
adc_power_simulated 60 bool 0 1 0 0 : Disabled
1 : Enabled		 Enables simulated power ADC counts.
adc_power_simulated_counts 61 int16_t 0 4095 0 - Simulated counts for Power ADC channel.
adc_thermistor_simulated 64 bool 0 1 0 0 : Disabled
1 : Enabled		 Enables simulated Thermistor ADC counts.
adc_thermistor_simulated_counts 65 int16_t 0 4095 0 - Simulated counts for Thermistor ADC channel.
adc_vref_simulated 66 bool 0 1 0 0 : Disabled
1 : Enabled		 Enables simulated Vref ADC counts.
adc_vref_simulated_counts 67 int16_t 0 4095 0 - Simulated counts for VRef ADC channel.
current_1_simulated 80 bool 0 1 0 0 : Disabled
1 : Enabled		 Enables simulated data for Current Input on AIN1.
current_1_simulated_value 81 float - - 0 - Simulated Current Input on AIN1 value.
current_2_simulated 82 bool 0 1 0 0 : Disabled
1 : Enabled		 Enables simulated data for Current Input on AIN2.
current_2_simulated_value 83 float - - 0 - Simulated Current Input in AIN2 value.
current_3_simulated 84 bool 0 1 0 0 : Disabled
1 : Enabled		 Enables simulated data for Current Input on AIN3.
current_3_simulated_value 85 float - - 0 - Simulated Current Input on AIN3 value.
current_4_simulated 86 bool 0 1 0 0 : Disabled
1 : Enabled		 Enables simulated data for Current Input on AIN4.
current_4_simulated_value 87 float - - 0 - Simulated Current Input on AIN4 value.
mag_switch_simulated 104 bool 0 1 0 0 : Disabled
1 : Enabled		 Enables simulated data for the Mag Switch.
mag_switch_simulated_value 105 bool 0 1 0 0 : Off
1 : On		 Simulated data for the Mag Switch.
power_volts_simulated 98 bool 0 1 0 0 : Disabled
1 : Enabled		 Enables simulated data for power voltage.
power_volts_simulated_value 99 float - - 0 - Simulated power voltage value.
pressure_simulated 78 bool 0 1 0 0 : Disabled
1 : Enabled		 Enables simulated data for Pressure sensors.
pressure_simulated_value 79 float - - 0 - Simulated Pressure sensor value.
tamper_switch_simulated 106 bool 0 1 0 0 : Disabled
1 : Enabled		 Enables simulated data for the Tamper Switch.
tamper_switch_simulated_value 107 bool 0 1 0 0 : Off
1 : On		 Simulated data for the Tamper Switch.
temperature_1_simulated 90 bool 0 1 0 0 : Disabled
1 : Enabled		 Enables simulated data for Thermistor on TH1.
temperature_1_simulated_value 91 float - - 0 - Simulated Thermistor on TH1 value.
temperature_2_simulated 92 bool 0 1 0 0 : Disabled
1 : Enabled		 Enables simulated data for Thermistor on TH2.
temperature_2_simulated_value 93 float - - 0 - Simulated Thermistor on TH2 value.
temperature_3_simulated 94 bool 0 1 0 0 : Disabled
1 : Enabled		 Enables simulated data for Thermistor on TH3.
temperature_3_simulated_value 95 float - - 0 - Simulated Thermistor on TH3 value.
temperature_4_simulated 96 bool 0 1 0 0 : Disabled
1 : Enabled		 Enables simulated data for Thermistor on TH4.
temperature_4_simulated_value 97 float - - 0 - Simulated Thermistor on TH4 value.
ultrasonic_simulated 76 bool 0 1 0 0 : Disabled
1 : Enabled		 Enables simulated data for the Ultrasonic sensor.
ultrasonic_simulated_value 77 float - - 0 - Simulated Ultrasonic sensor value.
vref_simulated 88 bool 0 1 0 0 : Disabled
1 : Enabled		 Enables simulated data for Vref.
vref_simulated_value 89 float - - 0 - Simulated Vref value.

Static Read-only parameters

The following parameters are read-only and do not change during runtime.

Name id type min /
min length		 max /
max length		 Default Enumeration Desc
api_version 41 string 6 11 “0.0.2” - The API attribute version that the firmware supports.
bluetooth_address 149 string 12 12 ”” - Bluetooth address.
board 117 string 1 64 “my_board” - Zephyr board the firmware is built for.
dump_path 114 string 0 32 “/lfs1/dump.txt” - Absolute file name for dump command.
firmware_version 9 string 5 64 “0.0.0+0” - Firmware Version.

Format = Major.Minor.Fix+build.
lwm2m_fup_pkg_name 146 string 1 32 my_firmware - Firmware update firmware package name.
lwm2m_fup_pkg_ver 147 string 1 32 “0.0.0” - Firmware update package version.
lwm2m_pwr_src 141 uint8_t 0 7 1 0 : DC
1 : Internal Battery
2 : External Battery
3 : Fuel Cell
4 : POE
5 : USB
6 : AC
7 : Solar		 Device power source.

This attribute maps to LwM2M path 3/0/6/0.
param_path 39 string 2 8 “/ext” - Folder on file system used for Parse/Dump commands.

Dynamic Read-only parameters

The following parameters are read-only and can change during runtime.

Name id type min /
min length		 max /
max length		 Default Enumeration Desc
analog_input_1 30 float - - - - Analog Input on AIN1 State.

Unit depends on Analog Input Configuration Type.

Units will either be in PSI, mm, mA, or Amps if AC current is selected.
analog_input_2 31 float - - - - Analog Input on AIN2 State.

Unit depends on Analog Input Configuration Type.

Units will either be in PSI, mm, mA, or Amps if AC current is selected.
analog_input_3 32 float - - - - Analog Input on AIN3 State.

Unit depends on Analog Input Configuration Type.

Units will either be in PSI, mm, mA, or Amps if AC current is selected.
analog_input_4 33 float - - - - Analog Input on AIN4 State.

Unit depends on Analog Input Configuration Type.

Units will either be in PSI, mm, mA, or Amps if AC current is selected.
attr_save_error_code 110 int32_t - - - - Result code from deferred settings saving.
battery_age 40 uint32_t - - 0 - Time in seconds that the battery has been in use.
ble_rssi 153 int16_t - - -128 - Received Signal Strength Indication.
bluetooth_flags 115 uint32_t - - - Bit 0 : Device Management Data Ready
Bit 1 : Mefault Data Ready
Bit 2 : Time was set
Bit 4: Active Mode
Bit 5 : Low Battery Alarm
Bit 8 : Tamper Switch
Bit 9 : Magnet Active		 Flags published over Bluetooth.
ge 19 float - - 0 - ADC calibrated thermistor gain error.
lwm2m_batt_stat 145 uint8_t 0 6 6 0 : Normal
1 : Charging
2 : Charging complete
3 : Damaged
4 : Low
5 : Not installed
6 : Unknown		 Device battery status.
lwm2m_pwr_src_volt 142 int32_t -600000 600000 0 - Device power source voltage.

This attribute maps to LwM2M path 3/0/7/0.
magnet_state 38 bool 0 1 0 0 : Magnet not detected
1 : Magnet detected		 Proximity of magnet to sensor used to activate sensor and start advertising when near.
oe 20 float - - 0 - ADC calibrated offset error.
power_voltage 26 float - - - - This is the voltage measured by the device at VDD.
qrtc 42 uint32_t - - - - Quasi-RTC (epoch, Seconds from Jan 1, 1970).
qrtc_last_set 43 uint32_t - - - - Last time the RTC was set.
reset_count 11 uint32_t - - 0 - Count of resets performed.
reset_reason 10 string 0 12 “RESETPIN” - Cause of last reset.
security_level 112 int8_t -1 4 0 -1 : Error
0 : L0
1 : L1
2 : L2
3 : L3
4 : L4		 Current Bluetooth security level as seen by the sensor.
tamper_switch_status 46 bool 0 1 0 0 : Not Active
1 : Active		 Returns the current state of the Tamper Switch.
temperature_result_1 22 float - - - - Thermistor on TH1 temperature in degrees C.
temperature_result_2 23 float - - - - Thermistor on TH2 temperature in degrees C.
temperature_result_3 24 float - - - - Thermistor on TH3 temperature in degrees C.
temperature_result_4 25 float - - - - Thermistor on TH4 temperature in degrees C.
uptime 12 int64_t - - - - Time in milliseconds since the last reboot.

GA2 Device parameter list

The following parameters are planned for support in the GA2 firmware release.

Non-volatile parameters

The following parameters are modifiable and saved to non-volatile memory.

Name id type min /
min length		 max /
max length		 Default Enumeration Desc  
analog_input_1_type 34 uint8_t 0 7 0 1 : Voltage 0V to 10VDC Analog Input Channel 1 (AIN1) configuration.

If changing a pressure sensor port any active pressure sensor ports must be first set to 0.		  
analog_input_2_type 35 uint8_t 0 7 0 1 : Voltage 0V to 10VDC Analog Input Channel 2 (AIN2) configuration.

If changing a pressure sensor port any active pressure sensor ports must be first set to 0.		  
analog_input_3_type 36 uint8_t 0 7 0 1 : Voltage 0V to 10VDC Analog Input Channel 3 (AIN3) configuration.

If changing a pressure sensor port any active pressure sensor ports must be first set to 0.		  
analog_input_4_type 37 uint8_t 0 7 0 1 : Voltage 0V to 10VDC Analog Input Channel 4 (AIN4) configuration.

If changing a pressure sensor port any active pressure sensor ports must be first set to 0.		  
digital_input_1_config 28 uint8_t 0 131 0 Bit 0 : Falling Edge
Bit 1 : Rising Edge
Bit 7 : Enable/Disable		 Bit mask representing Digital Input 1’s configuration.  
digital_input_2_config 29 uint8_t 0 131 0 Bit 0 : Falling Edge
Bit 1 : Rising Edge
Bit 7 : Enable/Disable		 Bit mast representing Digital Input 2’s configuration.  
digital_output_1_state 7 bool 0 1 0 0 : Off
1 : On		 The current state of Digital Output 1.  
digital_output_2_state 8 bool 0 1 0 0 : Off
1 : On		 The current state of Digital Output 2.  
event_filter_flags 116 uin32_t 0 2097151 2097151 Bit 4 : Voltage on AIN1
Bit 5 : Voltage on AIN2
Bit 6 : Voltage on AIN3
Bit 7 : Voltage on AIN4
Bit 19 : Digital Input 1
Bit 20 : Digital Input 2		 Filter to limit Bluetooth advertisement events.

Clearing the appropriate bit prevents that event type being broadcast in BLE advertisements.		  

Volatile parameters

The following parameters are modifiable with the values not persisting following device resets.

Name id type min /
min length		 max /
max length		 Default Enumeration Desc
digital_input_1_simulated 100 bool 0 1 0 0 : Disabled
1 : Enabled		 Enables simulated data for Digital Input 1.
digital_input_1_simulated_value 101 bool 0 1 0 0 : Off
1 : On		 Simulated data for Digital Input 1.
digital_input_2_simulated 102 bool 0 1 0 0 : Disabled
1 : Enabled		 Enables simulated data for Digital Input 2.
digital_input_2_simulated_value 103 bool 0 1 0 0 : Off
1 : On		 Simulated data for Digital Input 2.
voltage_1_simulated 68 bool 0 1 0 0 : Disabled
1 : Enabled		 Enables simulated data for Voltage Input on AIN1.
voltage_1_simulated_value 69 float - - 0 - Simulated Voltage Input on AIN1 value.
voltage_2_simulated 70 bool 0 1 0 0 : Disabled
1 : Enabled		 Enables simulated data for Voltage Input on AIN2.
voltage_2_simulated_value 71 float - - 0 - Simulated Voltage Input on AIN2 value.
voltage_3_simulated 72 bool 0 1 0 0 : Disabled
1 : Enabled		 Enables simulated data for Voltage Input on AIN3.
voltage_3_simulated_value 73 float - - 0 - Simulated Voltage Input on AIN3 value.
voltage_4_simulated 74 bool 0 1 0 0 : Disabled
1 : Enabled		 Enables simulated data for Voltage Input on AIN4.
voltage_4_simulated_value 75 float - - 0 - Simulated Voltage Input on AIN4 value.

Dynamic Read-only parameters

The following parameters are read-only and can change during runtime.

Name id type min /
min length		 max /
max length		 Default Enumeration Desc
bluetooth_flags 115 uint32_t - - - Bit 6 : Digital Input 1
Bit 7 : Digital Input 2		 Flags published over Bluetooth.
digital_input 27 uint8_t 0 3 0 Bit 0 : Digital Input 1 State
Bit 1 : Digital Input 2 State		 Digital Input states.