Skip to content

custom-sensor

Sensor view on GitHub

Create a telemetry sensor whose value is computed in Lua.

Install: copy the folder to SCRIPTS:/custom-sensor/ on the radio (or the simulator's scripts/ folder) and restart.

main.lua
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
-- Lua sensor example

local function init()
  system.registerSensor({
    manufacturer = "My manufacturer",  -- optional: only usable in models where this manufacturer is selected (Model / Edit)
    appIdStart = 0x5100,               -- first S.Port appId this definition matches
    appIdEnd = 0x510F,                 -- last S.Port appId this definition matches (optional, defaults to appIdStart)
    name = "My sensor",                -- sensor name
    unit = UNIT_KILOMETER_PER_HOUR,    -- sensor unit (UNIT_* constant, optional, defaults to UNIT_NONE)
    decimals = 1,                      -- number of decimals (optional, defaults to 0)
    min = 0.0,                         -- protocol minimum value (optional)
    max = 300.0,                       -- protocol maximum value (optional)
    userMin = 0.0,                     -- user-editable minimum value (optional, defaults to min)
    userMax = 100.0,                   -- user-editable maximum value (optional, defaults to max)
    onDiscover = function(source)      -- called when the sensors Discover creates this sensor
      print(string.format("Hello world! I am sensor appId=0x%04X name=%s", source:appId(), source:name()))
    end,    
  })
end

return {init=init}