NOTE: when a value referenced below uses a # in it, it can be any channel number available for that value.
Internal I/O | |
---|---|
din[#].state |
Returns the state, 0 or 1, for the digital input represented by the #. |
din[#].counter |
Returns the counter for the digital input represented by the #. Ranges from [0 - Integer.MAX] |
din[#].usagemeter |
Returns the usage meter for the digital input represented by the #. Ranges from [0 - Long.MAX] |
rout[#].state |
Returns the state, 0 or 1, for the relay output represented by the #. |
rout[#].usagemeter |
Returns the usage meter for the relay output represented by the #. Ranges from [0 - Long.MAX] |
Temperature Probe and Environmental Sensor | |
---|---|
temp[#].f or temp[#].farhenheit |
Returns the temperature in farhenheit from the Temperature Probe. |
temp[#].c or temp[#].celsius |
Returns the temperature in celsius from the Temperature Probe. |
Environmental Sensor I/O | |
---|---|
env[#].f or env[#].farhenheit |
Returns the temperature in farhenheit from the Environmental Sensor. |
env[#].c or temp[#].celsius |
Returns the temperature in celsius from the Environmental Sensor. |
env[#].humidity |
Returns the humidity from the Environmental Sensor. |
Validate Days of Week | |
---|---|
date.isDay(montuewedthufrisatsun) |
Returns true or false if the current day abbreviations matches one of the abbreviations provided. For example, providing “montuewedthufri” would return true on a weekday where “satsun” would return true on the weekend. |
Validate Time of Day | |
---|---|
time.isBefore("HH:MM") |
Returns true or false if the current time of day is equal to or before the string representation. The string representation must be in 24 hour format. For example, is the current time before or equal to “14:00”. |
time.isAfter("HH:MM") |
Returns true or false if the current time of day is equal to or after the string representation. The string representation must be in 24 hour format. For example, is the current time equal to or after “14:00”. |
4-20ma I/O | NOTE: When 2 4-20ma modules are connected, using 1 through 4 references the first modules inputs and using 5 through 8 reference the second modules inputs. As for outputs, using 1 or 2 refrence the first modules outputs and using 3 or 4 reference the second modules outputs. |
---|---|
iin[#].desc |
Returns the string that represents the description for the # channel. This can be set in the WebUI for each channel. |
iin[#].raw |
Returns the raw value of the 4-20ma input. 0-65520. |
iin[#].scaled |
Returns the scaled value. 4-20ma. The minimum and maximum for the scaled range can be set in the WebUI for each channel. |
iin[#].units |
Returns the string that represents the units for the # channel. “ma” will be returned by default. This can be set in the WebUI for each channel. |
iout[#].desc |
Returns the string that represents the description for the # channel. This can be set in the WebUI for each channel. |
iout[#].raw |
Returns the raw value of the 4-20ma output. 0-65520. |
iout[#].scaled |
Returns the scaled value. 4-20ma. The minimum and maximum for the scaled range can be set in the WebUI for each channel. |
iout[#].units |
Returns the string that represents the units for the # channel. “ma” will be returned by default. This can be set in the WebUI for each channel. |
10volt I/O | NOTE: When 2 Ten Volt modules are connected, using 1 through 4 references the first modules inputs and using 5 through 8 reference the second modules inputs. As for outputs, using 1 or 2 refrence the first modules outputs and using 3 or 4 reference the second modules outputs. |
---|---|
vin[#].desc |
Returns the string that represents the description for the # channel. This can be set in the WebUI for each channel. |
vin[#].raw |
Returns the raw value of the 4-20ma input. 0-65520. |
vin[#].scaled |
Returns the scaled value. 4-20ma. The minimum and maximum for the scaled range can be set in the WebUI for each channel. |
vin[#].units |
Returns the string that represents the units for the # channel. “ma” will be returned by default. This can be set in the WebUI for each channel. |
vout[#].desc |
Returns the string that represents the description for the # channel. This can be set in the WebUI for each channel. |
vout[#].raw |
Returns the raw value of the 4-20ma output. 0-65520. |
vout[#].scaled |
Returns the scaled value. 4-20ma. The minimum and maximum for the scaled range can be set in the WebUI for each channel. |
vout[#].units |
Returns the string that represents the units for the # channel. “ma” will be returned by default. This can be set in the WebUI for each channel. |
Control Panel | |
---|---|
fpled[#].state |
Returns true or false if the LED for the control panel channel is on or off. |