URLs and Commands

Bryan Mayland edited this page Jan 22, 2016 · 12 revisions

Both HeaterMeter and LinkMeter accept commands via URL-type form.

HeaterMeter URLs

  • Received via serial
  • No authentication
  • Begin with a forward slash (/)
  • End with CR or CR/LF
  • Maximum length: 64 characters
  • Do not URL encode parameters

LinkMeter URLs

  • Received via HTTP
  • Authentication possible
  • Begin with /luci/
  • URL encoded parameters OK
URL Description LM HM
/lm/ Main index or LinkMeter "home" page. Displays current temperature and fan status with graph.
  • rrd=file use file from stashpath instead of live
Y N
/lm/hmstatus Get last HeaterMeter status update in JSON format. Y N
/lm/rfstatus Get last RF12 status update in JSON format. Y N
/lm/stream Get streaming HeaterMeter status updates in HTTP server-sent events format. The individual events are in JSON format. Y N
/lm/conf Retrieve HeaterMeter configuration in JSON format. Y N
/lm/hist Get HeaterMeter history in CSV format, which is used to generate the graph.
  • rrd=X use X for the database file instead of the default (may include full path)
  • nancnt=X specifies the range of the returned data. Values are subject to change but: Not Present=auto 460=1h 360=6h 240=12h else 24h
Y N
/lm/light A lightweight, mobile friendly "home" page. Displays current temperature, fan speed and set point. Y N
/lm/login Bounce to the LinkMeter login page for authentication. Y N
/admin/lm/set Passed through to HeaterMeter one parameter at a time. See HeaterMeter Set Parameter list. A Y
/admin/lm/conf LinkMeter probe and behavior configuration. Front-end to /lm/set A N
/admin/lm/home The authenticated version of the home page, which allows modification of setpoint, probe names, etc. A N
/admin/lm/stashdb LinkMeter utility URL for managing databases
  • backup=1 backup to stashpath
  • restore=1 restore to active
  • reset=1 reset active
  • rrd=file use file instead of 'hm.rrd' for stashpath file (do not include path)
  • delete=1 delete stashpath file and any metadata
A N
/admin/lm/reboot Passthrough AVR reboot command A N
/admin/lm/alarms LinkMeter simple alarm script editor A N
/admin/lm/archive LinkMeter database archive. Front-end to /admin/lm/stashdb A N
/admin/lm/fw LinkMeter Arduino / AVR firmware upgrade A N
/admin/lm/credits LinkMeter software credits page A N
/reboot HeaterMeter software reboot N Y
/config HeaterMeter dump configuration N Y

HeaterMeter Set Parameters

The definitive source on HeaterMeter set parameters is the HeaterMeter README. All set parameters are proceeded by /set? followed by the parameter name. HeaterMeter only supports one setting one parameter at a time, LinkMeter can set several parameters at once.

Name Description
sp=AU Set the setpoint to integer A with optional units U. Supported Units are (A)DC Raw, (F)ahrenheit , (C)elcius, and (R)esistance. Setting the setpoint to a negative value switches to "manual mode" where the output percentage is set directly (-0 for 0%).
pidA=B Tune PID parameter A to value float B. A can be b (bias), p (proportional), i (integral), or d (derivative)
pnA=B Set probe name A to string B.
poA=B Set probe offset A to integer B.
pcN=A,B,C,R,TRM Set the probe coefficients and type for probe N. A, B, and C are the Steinhart-Hart coeffieicents and R is the fixed side of the probe voltage divider. A, B, C and R are floating point and can be specified in scienfific noation, e.g. 0.00023067434 -> 2.3067434e-4. TRM is either the type of probe OR an RF map specifier. If TRM is less than 128, it indicates a probe type. Probe types are 0=Disabled, 1=Internal, 2=RFM12B. Probe types of 128 and above are implicitly of type RFM12B and indicate the transmitter ID of the remote node (0-63) + 128. e.g. Transmitter ID 2 would be passed as 130. The value of 255 (transmitter ID 127) means "any" transmitter and can be used if only one transmitter is used. Any of A,B,C,R,TRM set to blank will not be modified. Probe numbers are 0=pit 1=food1 2=food2 3=ambient
lb=A,B Set the LCD backlight to A. Range is 0 (off) to 255 (full). B sets the home screen mode. 255 for two-line display, or probe number (0-30 for bignum display
ld=A,B,C Set the offset of the Lid Open autodetect in % of set point to A. Set the duration of the Lid Open timer in seconds to B. You can not set the duration to less than LIDOPEN_MIN_AUTORESUME. Max is 65535 seconds. C is used to enable or disable a currently running lid detect mode. Non-zero will enter lid open mode, zero will disable lid open mode
al=L,H[,L,H...] Set probe alarms thresholds. Setting to a negative number will disable the alarm, setting to 0 will force the current set value negative (disabling the alarm but retaining the set value)
fn=FL,FH,SL,SH,Flags,MSS,FAF,SAC Set the fan output parameters. FL = min fan speed before "long PID" mode, FH = max fan speed, SL = Servo Low (in 10x usec), SH = Servo High (in 10x usec), MSS = Max Startup Speed, FAF = Fan active floor, SAC = Servo active ceiling. Flags = Bitfield 0=Invert Fan, 1=Invert Servo
tt=XXX[,YYY] Display a "toast" message on the LCD which is temporarily displayed over any other menu and is cleared either by timeout or any button press. XXX and YYY are the two lines to displau and can be up to 16 characters each.
Probe Number Description
0 Pit - This is the probe that controls the blower
1 Food Probe 1
2 Food Probe 2
3 Food Probe 3 / Ambient
Probe Type (URL) Probe Type (Code) Description
0 (Undefined) Do not change probe type
1 PROBETYPE_DISABLED (0) Disabled. Do not measure or report a value for this probe
2 PROBETYPE_INTERNAL (1) Internal. Probe connected directly to HeaterMeter via voltage divider / probe jack / thermistor
3 PROBETYPE_RF12 (2) RFM12B. RF Wireless via RFM12B radio transciever. Probes of this type also require an RFMap item to map the appropriate source node and pin.