Difference between revisions of "ISY-994i Series:EMail and Networking Substitution Variables"

From Universal Devices, Inc. Wiki
Jump to: navigation, search
(Substitution Variables)
Line 1: Line 1:
==Email Custom Content==
'''Note''': Both the '''Subject''' and the '''Body'''' must be non empty or, otherwise, emails shall not be sent!
==Substitution Variables==
==Substitution Variables==
*Custom Email definitions are available in the Admin Console by going to the '''Configuration''' / '''Emails/Notifications''' / '''Customizations''' tab
*Custom Email definitions are available in the Admin Console by going to the '''Configuration''' / '''Emails/Notifications''' / '''Customizations''' tab

Revision as of 15:03, 6 March 2016

Email Custom Content

Note: Both the Subject and the Body' must be non empty or, otherwise, emails shall not be sent!

Substitution Variables

  • Custom Email definitions are available in the Admin Console by going to the Configuration / Emails/Notifications / Customizations tab
  • Substitution variables are available inside custom email definitions in the form ${<variable name>}.
  • Substitutions can be manually made in the body, URL or header of Network Resources from version 4.3.26. If you included them in the URL then you cannot use the 'Encode URL' option
  • In most cases, these variables use the ID of the element being referenced
    • For example ${sys.node.11 22 AA 1.name} would use the name of the device node whose address is 11 22 AA 1
    • Instead of specifying a fixed address, the special character # may be used to reference the element in the event that caused the program to run. (Does not work in network resources)
      • For example, if a status event for node 11 22 AA 1 caused a program to run, then ${sys.node.#.name} would use 11 22 AA 1 as the address.
      • If a variable has more than one ID then any combination of fixed addresses and # is valid. For example, the following are all valid
        • ${elk.keypad.1.key.1.led} -- Show LED status of F1 Key on Keypad 1
        • ${elk.keypad.#.key.#.led} -- Show LED status of event Key on event Keypad
        • ${elk.keypad.#.key.3.led} -- Show LED status of F3 Key on event Keypad
        • ${elk.keypad.1.key.#.led} -- Show LED status of event Key on Keypad 1
    • User defined Integer and State variables are referenced with their type (1-Integer, 2-State) and ID Number for example: ${var.2.3} for the state variable with ID # 3

System Variables

Value Name Description
${sys.date} Date
${sys.time} Time
${sys.time24} Time (24 hour)
${sys.time12} Time (am/pm)
${sys.sunrise} Sunrise
${sys.sunrise12} Sunrise (am/pm)
${sys.sunrise24} Sunrise (24 hour)
${sys.sunset} Sunset
${sys.sunset12} Sunset (am/pm)
${sys.sunset24} Sunset (24 hour)

User Variables

Value Name Description
${var.<valueType>.<valueID>} Type 1 = Integer, Type 2 = State

Device Variables and Properties

Many properties are subject to device capability You can obtain all available properties for a specific node via the REST API at /rest/nodes/<address>

Variable Example Description
sys.node.<address>.name sys.node.11 22 AA 1.name Name of the device node
sys.node.<address>.addr sys.node.#.addr Address of the device node
sys.node.<address>.<valueName>.ST sys.node.11 22 AA 1.ST The formatted specified value
sys.node.<address>.<valueName>.raw sys.node.11 22 AA 1.ST.raw The unformated specified value
sys.node.<address>.<valueName>.OL sys.node.11 22 AA 1.OL On Level
sys.node.<address>.<valueName>.RR sys.node.11 22 AA 1.RR Ramp Rate
sys.node.<address>.<valueName>.ERR sys.node.11 22 AA 1.ERR Error
sys.node.<address>.<valueName>.CLISPH sys.node.11 22 AA 1.CLISPH Heat Setpoint
sys.node.<address>.<valueName>.CLISPC sys.node.11 22 AA 1.CLISPC Cool Setpoint
sys.node.<address>.<valueName>.CLIFS sys.node.11 22 AA 1.CLIFS Fan State
sys.node.<address>.<valueName>.CLIMD sys.node.11 22 AA 1.CLIMD Thermostat Mode
sys.node.<address>.<valueName>.CLIHUM sys.node.11 22 AA 1.CLIHUM Humidity
sys.node.<address>.<valueName>.CLIHCS sys.node.11 22 AA 1.CLIHCS Heat/Cool State
sys.node.<address>.<valueName>.UOM sys.node.11 22 AA 1.UOM Unit
sys.node.<address>.<valueName>.CV sys.node.11 22 AA 1.CV Current Voltage
sys.node.<address>.<valueName>.CC sys.node.11 22 AA 1.CC Current Current
sys.node.<address>.<valueName>.PPW sys.node.11 22 AA 1.PPW Polarized Power Used
sys.node.<address>.<valueName>.TPW sys.node.11 22 AA 1.TPW Total Energy Used
sys.node.<address>.<valueName>.PF sys.node.11 22 AA 1.PF Power Factor

Elk Variables

Variable Example Description
elk.area.<areaNumber>.name elk.area.1.name Name of the Area
elk.area.<areaNumber>.armUpState elk.area.1.armUpState Area Arm Up State
elk.area.<areaNumber>.alarmStatus elk.area.1.alarmStatus Area Alarm Status
elk.area.<areaNumber>.bypassState elk.area.1.bypassState Area Bypass State
elk.zone.<zoneNumber>.name elk.zone.1.name Name of the zone
elk.zone.<zoneNumber>.alarmDef elk.zone.1.alarmDef Zone Alarm definition
elk.zone.<zoneNumber>.voltage elk.zone.1.voltage Zone voltage
elk.zone.<zoneNumber>.status elk.zone.1.status Zone status
elk.zone.<zoneNumber>.pstatus elk.zone.1.pstatus Zone physical status
elk.zone.<zoneNumber>.bypassState elk.zone.1.bypassState Zone bypass state
elk.zone.<zoneNumber>.temp elk.zone.1.temp Zone temperature
elk.output.<outputNumber>.name elk.output.1.name Output name
elk.output.<outputNumber>.status elk.output.1.status Output status
elk.tstat.<thermostatNumber>.name elk.tstat.1.name Thermostat name
elk.tstat.<thermostatNumber>.ST elk.tstat.1.ST Thermostat temperature
elk.tstat.<thermostatNumber>.CLIMD elk.tstat.1.CLIMD Thermostat mode
elk.tstat.<thermostatNumber>.CLIFS elk.tstat.1.CLIFS Thermostat fan state
elk.tstat.<thermostatNumber>.CLISPH elk.tstat.1.CLISPH Thermostat heat setpoint
elk.tstat.<thermostatNumber>.CLISPC elk.tstat.1.CLISPC Thermostat cool setpoint
elk.tstat.<thermostatNumber>.CLIHOLD elk.tstat.1.CLIHOLD Thermostat temperature hold
elk.keypad.<keypadNumber>.name elk.keypad.1.name Keypad name
elk.keypad.<keypadNumber>.temp elk.keypad.1.temp Keypad temperature
elk.keypad.<keypadNumber>.key.<keyNumber>.led elk.keypad.1.key.2.led Key LED state

Weather Variables

Variable Example Comments
Temperature: ${mod.weather.temp.current} Current Temperature
High Temperature: ${mod.weather.temp.high} Highest reached today
Low Temperature: ${mod.weather.temp.low} Lowest reached today
Feels Like: ${mod.weather.temp.feelslike} Current temperature but factors in wind chill and humidity.
Average Temperature: ${mod.weather.temp.avg} Avg temp from Midnight till now
Humidity: ${mod.weather.humidity} Current Humidity
Pressure: ${mod.weather.pressure} Current Pressure
Dew Point: ${mod.weather.dewpoint} Current Dew Point
Wind Speed: ${mod.weather.wind.speed} Current Wind Speed
Wind Direction: ${mod.weather.wind.direction} Current Wind Direction
Wind Gust Speed: ${mod.weather.gust.speed} Current Wind Gust Speed
Gust Wind Direction: ${mod.weather.gust.direction} Current Gust Direction
Light: ${mod.weather.light.level} Current Light Level
Total Rain Today: ${mod.weather.rain.today} Rain so far today.
Elevation: ${mod.weather.elevation} Elevation at Weather Station
Coverage: ${mod.weather.coverage} Defines things such as areas, chances, etc. See key below.
Intensity: ${mod.weather.intensity} Defines things such as light, heavy, etc See key below.
Condition: ${mod.weather.condition} Defines things such as Hail, rain, showers, etc. See key below.
Cloud Condition: ${mod.weather.cloud.condition} Defines things such as clear, sunny, cloudy, etc. See key below.
24Hr High Temperature: ${mod.weather.temp.hi.24h} Forecast high temperature next 24 hours.
24Hr Low Temperature: ${mod.weather.temp.low.24h} Forecast low temperature next 24 hours.
24Hr Average Temperature: ${mod.weather.temp.avg.24h} Forecast average temperature next 24 hours.
24Hr Humidity: ${mod.weather.humidity.24h} Forecast humidity next 24 hours.
24Hr Rain: ${mod.weather.rain.24h} Forecast rainfall next 24 hours.
24Hr Snow: ${mod.weather.snow.24h} Forecast snowfall next 24 hours.
24 Hr Coverage: ${mod.weather.coverage.24h} Forecast coverage next 24 hours. See key below.
24Hr Intensity: ${mod.weather.intensity.24h} Forecast intensity next 24 hours. See key below.
24Hr Condition: ${mod.weather.condition.24h} Forecast condition next 24 hours. See key below.
24Hr Cloud Condition: ${mod.weather.cloud.condition.24h} Forecast cloud cover next 24 hours. See key below.
Avg Temperature Tomorrow: ${mod.weather.temp.avg.tomorrow} Forecast average temperature tomorrow.
High Temperature Tomorrow: ${mod.weather.temp.hi.tomorrow} Forecast high temperature tomorrow.
Low Temperature Tomorrow: ${mod.weather.temp.low.tomorrow} Forecast low temperature tomorrow.
Humidity Tomorrow: ${mod.weather.humidity.tomorrow} Forecast humidity tomorrow.
Wind Speed Tomorrow: ${mod.weather.wind.speed.tomorrow} Forecast wind speed tomorrow.
Wind Gust Speed Tomorrow: ${mod.weather.gust.speed.tomorrow} Forecast wind gust tomorrow.
Rain Tomorrow: ${mod.weather.rain.tomorrow} Forecast rainfall tomorrow.
Snow Tomorrow: ${mod.weather.snow.tomorrow} Forecast snowfall tomorrow.
Coverage Tomorrow: ${mod.weather.coverage.tomorrow} Forecast coverage tomorrow. See key below.
Intensity Tomorrow: ${mod.weather.intensity.tomorrow} Forecast intensity tomorrow. See key below.
Condition Tomorrow: ${mod.weather.condition.tomorrow} Forecast condition tomorrow. See key below.
Cloud Condition Tomorrow: ${mod.weather.cloud.condition.tomorrow} Forecast cloud cover tomorrow. See key below.

Climate Data Key

Climate Coverage defines things such as areas, chances, etc.

  • Value 1 - Areas of
  • Value 2 - Brief
  • Value 3 - Chance of
  • Value 4 - Definite
  • Value 5 - Frequent
  • Value 6 - Intermittent
  • Value 7 - Isolated
  • Value 8 - Likely
  • Value 9 - Numerous
  • Value 10 - Occasional
  • Value 11 - Patchy
  • Value 12 - Periods of
  • Value 13 - Slight chance
  • Value 14 - Scattered
  • Value 15 - In the vicinity / Nearby
  • Value 16 - Widespread

Climate Intensity defines things such as light, heavy, etc.

  • Value 1 - Very light
  • Value 2 - Light
  • Value 3 - Heavy
  • Value 4 - Very heavy

Climate Weather Condition defines things such as Hail, rain, showers, etc.

  • Value 1 - Hail
  • Value 2 - Blowing dust
  • Value 3 - Blowing sand
  • Value 4 - Mist
  • Value 5 - Blowing snow
  • Value 6 - Fog
  • Value 7 - Frost
  • Value 8 - Haze
  • Value 9 - Ice Crystals
  • Value 10 - Ice fog
  • Value 11 - Ice pellets / sleet
  • Value 12 - Smoke
  • Value 13 - Drizzle
  • Value 14 - Rain
  • Value 15 - Rain showers
  • Value 16 - Rain/snow mix
  • Value 17 - Snow/sleet mix
  • Value 18 - Wintry mix
  • Value 19 - Snow
  • Value 20 - Snow showers
  • Value 21 - Thunderstorms
  • Value 22 - Unknown Precipitation (May Occur in an automated observation station, which cannot determine the precip type falling.)
  • Value 23 - Volcanic ash
  • Value 24 - Water spouts
  • Value 25 - Freezing fog
  • Value 26 - Freezing drizzle
  • Value 27 - Freezing rain
  • Value 28 - Freezing spray

Climate Cloud Condition defines things such as clear, sunny, cloudy, etc.

  • Value 1 - Clear - Cloud coverage is 0-7% of the sky.
  • Value 2 - Fair/mostly sunny - Cloud coverage is 7-32% of the sky.
  • Value 3 - Partly cloudy - Cloud coverage is 32-70% of the sky.
  • Value 4 - Mostly cloudy - Cloud coverage is 70-95% of the sky.
  • Value 5 - Cloudy