Universal Devices, Inc. Wiki - User contributions [en]

Polisy Developers:ISY:API:Appendix:Units of Measure

2024-03-07T18:29:41Z

Chris: 121 was missing

[[Polisy_Developers]] : [[Polisy_Developers:ISY | ISY]] : [[Polisy_Developers:ISY:API | API]] : [[Polisy_Developers:ISY:API:Appendix | Appendix]] : Units of Measure (UOM)

In the ISY, units of measure include the scientific units of measure as well as custom types. A unit
of measure is a numeric type that fully defines a value. Values in square brackets are keywords that
may be specified for the unit of measure instead of the numeric value when sending a request to ISY.
The ISY will always return the numeric value for the unit of measure.

Polisy
Version ID Description
0 = Unit of measure is unknown
1 = ampere (amp) '''[amp, ampere]'''
2 = boolean
3 = btu/h [btuh]
4 = celsius (C) '''[C, celsius]'''
5 = centimeter (cm) [cm]
6 = cubic feet
7 = cubic feet per minute (cfm)
8 = cubic meter
9 = day
10 = days
11 = Deadbolt status (See below)
12 = decibel (db) '''[db]'''
13 = decibel A (dbA) '''[dbA]'''
14 = generic temperature in degree
15 = Door lock alarm (See below)
16 = european macroseismic
17 = Fahrenheit (F) '''[F]'''
18 = feet
19 = hour
20 = hours
21 = absolute humidity
22 = relative humidity
23 = inches of mercury (inHg)
24 = inches/hour
25 = index
26 = kelvin (K) '''[K]'''
27 = keyword
28 = kilogram (kg) '''[kg]'''
29 = kilovolt (kV)
30 = kilowatt (kW)
31 = kilopascal (kPa) '''[kpa]'''
32 = kilometers/hour (KPH)
33 = kilowatts/hour (kWH) '''[kwh]'''
34 = liedu
35 = liter (l)
36 = lux '''[lux]'''
37 = mercalli
38 = meter (m)
39 = cubic meters/hour
40 = meters/sec (m/s)
41 = milliamp (mA)
42 = millisecond (ms)
43 = millivolt (mV)
44 = minute
45 = duration in minutes
46 = millimeters/hour (mm/hr)
47 = month (Jan=1, Feb=2, etc.)
48 = miles/hour (MPH)
49 = - Reserved -
50 = ohm '''[ohm]'''
51 = percent
52 = pound
53 = Power Factor
54 = Parts/Million (PPM)
55 = pulse count
56 = The raw value as reported by the device
57 = second
58 = Duration in seconds
59 = seimens/meter
60 = body wave magnitude scale
61 = Richter scale
62 = moment magnitude scale
63 = surface wave magnitude scale
64 = shindo
65 = SML
66 = Thermostat heat/cool state (See below)
67 = Thermostat mode (See below)
68 = Thermostat fan mode (See below)
69 = US gallon
70 = User number
71 = UV index
72 = volt '''[V, volt]'''
73 = watt '''[W, watt]'''
74 = watts/square meter
75 = weekday (Sun=0, Sat=1, etc.)
76 = Wind Direction in degrees (See below)
77 = year
78 = 0-Off 100-On, 101-Unknown
79 = 0-Open 100-Close, 101-Unknown
80 = Thermostat fan run state (See below)
81 = Thermostat fan mode override
82 = millimeter '''[mm]'''
83 = kilometer
84 = Secure Mode 0-Unlock 1-Lock
85 = Ohm Meter (Electrical resistivity)
86 = KiloOhm
87 = cubic meter/cubic meter
88 = Water activity
89 = rotations/Minute (RPM)
90 = Hertz (Hz)
91 = Angle Position degrees relative to North Pole
92 = Angle Position degrees relative to South Pole
93 = Power Management Alarm (See below)
94 = Appliance Alarm (See below)
95 = Home Health Alarm (See below)
96 = VOC Level (See below)
97 = Barrier Status (See below)
98 = Insteon Thermostat Mode (See below) - For Insteon compatibility, should use 67 (Thermostat Mode)
99 = Insteon Thermostat Fan Mode (See below) - For Insteon compatibility, should use 68 (Thermostat Fan Mode)
100 = A Level from 0-255 e.g. brightness of a dimmable lamp
101 = Degree multiplied by 2 (for Insteon compatibility) - For Insteon compatibility, should use 14 (degree)
102 = Kilowatt Second (kWs)
103 = Dollar
104 = Cents
105 = Inches
106 = Millimeters per day
107 = Raw 1-byte unsigned value
108 = Raw 2-byte unsigned value
109 = Raw 3-byte unsigned value
110 = Raw 4-byte unsigned value
111 = Raw 1-byte signed value
112 = Raw 2-byte signed value
113 = Raw 3-byte signed value
114 = Raw 4-byte signed value
115 = Most recent On style action taken for lamp control
116 = Mile
117 = Millibar (mb), typically used in barometric reports
118 = Hectopascal (hPa), typically used in barometric reports
119 = Watt Hour
120 = Inches per day
121 = Mole per cubic meter (mol/m3)
122 = Microgram per cubic meter (ug/m3)
123 = Becquerel per cubic meter (bq/m3)
124 = Picocuries per liter (pCi/l)
125 = Acidity (pH)
126 = Beats per Minute (bpm)
127 = Millimeters of mercury (for blood pressure)
128 = Joule (J)
129 = Body Mass Index (BMI)
130 = Liters per hour
131 = Decibel Milliwatts (dBm)
132 = Breaths per minute
133 = Kilohertz (kHz)
134 = Meters per squared Seconds (m/sec2)
135 = For Apparent Power, VA = Volt-Amp
136 = For Reactive Power, VAR = Volt-Amp Reactive
137 = NTP DateTime - Number of seconds since 1900
138 = Pound per square inch (PSI)
139 = 0 to 360 degrees
140 = Milligram per liter (mg/l)
141 = Newton (N)
142 = US gallons per second
143 = US gallons per minute
144 = US gallons per hour
''5.4.2'' 145 = Text
''5.4.2'' 146 = Reserved for System Editors (Do not use)
''5.6.1'' 147 = XML
''5.6.1'' 148 = Reserved for System Editors (Do not use)
''5.6.3'' 149 = 0-360 Degree of Hue
''5.6.3'' 150 = URL for streaming video/audio/etc.
''5.6.4'' 151 = Unix Timestamp

Special Values

11 = Deadbolt status
0 - Unlocked
100 - Locked
101 - Unknown
102 - Jammed

15 = Door lock alarm
1 - Master Code Changed
2 - Tamper Code Entry Limit
3 - Escutcheon Removed
4 - Key/Manually Locked
5 - Locked by Touch
6 - Key/Manually Unlocked
7 - Remote Locking Jammed Bolt
8 - Remotely Locked
9 - Remotely Unlocked
10 - Deadbolt Jammed
11 - Battery Too Low to Operate
12 - Critical Low Battery
13 - Low Battery
14 - Automatically Locked
15 - Automatic Locking Jammed Bolt
16 - Remotely Power Cycled
17 - Lock Handling Completed
19 - User Deleted
20 - User Added
21 - Duplicate PIN
22 - Jammed Bolt by Locking with Keypad
23 - Locked by Keypad
24 - Unlocked by Keypad
25 - Keypad Attempt outside Schedule
26 - Hardware Failure
27 - Factory Reset
27 = Factory Reset
28 = Manually Not Fully Locked
29 = All User Codes Deleted
30 = New User Code Not Added (Duplicate Code)
31 = Keypad Temporarily Disabled
32 = Keypad Busy
33 = New Program Code Entered
34 = RF Unlock With Invalid User Code
35 = RF Lock With Invalid User Codes
36 = Window/Door Is Open
37 = Window/Door Is Closed
38 = Window/Door Handle Is Open
39 = Window/Door Handle Is Closed
40 = User Code Entered On Keypad
41 = Power Cycled

66 = Thermostat heat/cool state
0 - Idle
1 - Heating
2 - Cooling
3 - Fan Only
4 - Pending Heat
5 - Pending Cool
6 - Vent
7 - Aux Heat
8 - 2nd Stage Heating
9 - 2nd Stage Cooling
10 - 2nd Stage Aux Heat
11 - 3rd Stage Aux Heat

67 = Thermostat mode
0 - Off
1 - Heat
2 - Cool
3 - Auto
4 - Aux/Emergency Heat
5 - Resume
6 - Fan Only
7 - Furnace
8 - Dry Air
9 - Moist Air
10 - Auto Changeover
11 - Energy Save Heat
12 - Energy Save Cool
13 - Away
14 = Program Auto
15 = Program Heat
16 = Program Cool

68 = Thermostat fan mode
0 - Auto
1 - On
2 - Auto High
3 - High
4 - Auto Medium
5 - Medium
6 - Circulation
7 - Humidity Circulation
8 = Left & Right Circulation
9 = Up & Down Circulation
10 = Quiet

76 = A 1-360 degree clockwise Wind Direction, 0 indicates no wind
0 = No Wind
90 = East
180 = South
270 = West
360 = North

80 = Thermostat fan running state
0 - Off
1 - On
2 - On High
3 - On Medium
4 - Circulation
5 - Humidity Circulation
6 - Right/Left Circulation
7 - Up/Down Circulation
8 - Quiet Circulation

93 = Power Management Alarm
1 - Power Applied
2 - Ac Mains Disconnected
3 - Ac Mains Reconnected
4 - Surge Detection
5 - Volt Drop Or Drift
6 - Over Current Detected
7 - Over Voltage Detected
8 - Over Load Detected
9 - Load Error
10 - Replace Battery Soon
11 - Replace Battery Now
12 - Battery Is Charging
13 - Battery Is Fully Charged
14 - Charge Battery Soon
15 - Charge Battery Now

94 = Appliance Alarm
1 - Program Started
2 - Program In Progress
3 - Program Completed
4 - Replace Main Filter
5 - Failure To Set Target Temperature
6 - Supplying Water
7 - Water Supply Failure
8 - Boiling
9 - Boiling Failure
10 - Washing
11 - Washing Failure
12 - Rinsing
13 - Rinsing Failure
14 - Draining
15 - Draining Failure
16 - Spinning
17 - Spinning Failure
18 - Drying
19 - Drying Failure
20 - Fan Failure
21 - Compressor Failure

95 = Home Health Alarm
1 - Leaving Bed
2 - Sitting On Bed
3 - Lying On Bed
4 - Posture Changed
5 - Sitting On Edge Of Bed

96 = VOC Level
1 - Clean
2 - Slightly Polluted
3 - Moderately Polluted
4 - Highly Polluted

97 = Barrier Status
0 - Closed
1-99 - Percent Closed (1% = almost Closed, 99% = almost Open)
100 - Open
101 - Unknown
102 - Stopped
103 - Closing
104 - Opening

98 = Insteon Thermostat mode
0 - Off
1 - Heat
2 - Cool
3 - Auto
4 - Fan Only
5 - Program Auto
6 - Program Heat
7 - Program Cool

99 = Insteon Thermostat fan mode
7 - On
8 - Auto

115 = Most recent On style action taken for lamp control
0 - On
1 - Off
2 - Fade Up
3 - Fade Down
4 - Fade Stop
5 - Fast On
6 - Fast Off
7 - Triple Press (On)
8 - Triple Press (Off)
9 - 4 x Press (On)
10 - 4 x Press (Off)
11 - 5 x Press (On)
12 - 5 x Press (Off)

Polisy Developers:ISY:API:Node Server:REST Support in ISY

2023-09-12T15:08:52Z

Chris: Clarify limits of reporting a command

[[Polisy_Developers | Polisy Developers]] : [[Polisy_Developers:ISY | ISY]] : [[Polisy_Developers:ISY:API | API]] : [[Polisy_Developers:ISY:API:Node_Server | Node Server]] : REST support in ISY

__TOC__

REST is an easy to use URL based command set which allows the developer to communicate with the ISY.

Unless otherwise specified, all REST commands use HTTP GET method.

See [[Polisy_Developers:ISY:API:Appendix:REST_Return_Codes | REST return codes]]

Notes:
* URL Prefix: /rest/ns/<profileNumber>/
* The profileNumber specified on the URL determines which ISY userid/password will be accepted by the ISY for the request.
* Maximum URL size is 255 bytes

==Node Management==

/'''nodes'''/''<nodeAddress>''/'''add'''/''<nodeDefId>''?'''primary'''=''<primary>''&'''name'''=''<nodeName>''[&'''nls'''=''<nlsKey>'']

Adds a node to the ISY. To make this node the primary, set ''primary'' to the same value as ''nodeAddress''

{|
|'''''nodeAddress''''' || The full address of the node (e.g. 'n005_dimmer_1')
|-
|'''''nodeDefId''''' || The id of the node definition to use for this node
|-
|'''''primary''''' || The primary node for the device this node belongs to
|-
|'''''nodeName''''' || The name of the node
|-
|'''''nls''''' || ''(Optional)'' NLS key string for information specific to this node
|}

E.g.
{| style="font-family: courier;"
|/rest/ns/5/nodes/n005_dimmer_2/add/MyDimmer?primary=n005_dimmer_1&name=Dimmer 2&nls=012B
|}

----
'''/add/nodes'''

Sends a request to the node server to have it add all of its nodes to the ISY. This API is intended for ISY clients, and is never used by a node server.

E.g.
{| style="font-family: courier;"
|/rest/ns/5/add/nodes
|}

----
/'''nodes'''/''<nodeAddress>''/'''change'''/''<nodeDefId>''[?'''nls'''=''<nlsKey>'']

Changes the node definition to use for an existing node. An example of this is may be to change a thermostat node from Fahrenheit to Celsius.
{|
|'''''nodeAddress''''' || The full address of the node (e.g. 'n005_dimmer_1')
|-
|'''''nodeDefId''''' || The id of the node definition to use for this node
|-
|'''''nls''''' || ''(Optional)'' NLS key string for information specific to this node
|}

E.g.
{| style="font-family: courier;"
|/rest/ns/5/nodes/n005_tstat_1/change/ThermostatCelsius?nls=4511
|}

----
/'''nodes'''/''<nodeAddress>''/'''remove'''

Removes a node from the ISY. A node cannot be removed if it is the primary node for at least one other node.
{|
|'''''nodeAddress''''' || The full address of the node (e.g. 'n005_dimmer_1')
|}

E.g.
{| style="font-family: courier;"
|/rest/ns/5/nodes/n005_dimmer_2/remove
|}

----
/'''nodes'''/''<nodeAddress>''/'''rename'''/''<newName>''
''(First available in Polisy 5.4.3)''

Renames an existing node.
{|
|'''''nodeAddress''''' || The full address of the node (e.g. 'n005_dimmer_1')
|-
|'''''newName''''' || The new name of the node
|}

E.g.
{| style="font-family: courier;"
|/rest/ns/5/nodes/n005_dimmer_2/rename/Kitchen Dimmer
|}

----
/'''nodes'''/''<nodeAddress>''/'''set'''/'''hint'''/''<value>''

Adds a hint to the node. This ISY stores the value with the node but does not use this value in any way.
{|
|'''''nodeAddress''''' || The full address of the node (e.g. 'n005_dimmer_1')
|-
|'''''value''''' ||A four byte integer
|}

E.g.
{| style="font-family: courier;"
|/rest/ns/5/nodes/n005_dimmer_2/set/hint/101
|}

==Reporting status updates==

{|
|/'''nodes'''/''<nodeAddress>''/'''report'''/'''status'''
|-
|/'''nodes'''/''<nodeAddress>''/'''report'''/'''status'''/''<statusName>''/''<value>''/''<uom>''
|-
|/'''nodes'''/''<nodeAddress>''/'''report'''/'''status'''/''<statusName>''/''<value>''/''<uom>''/'''text'''/''<text>'' ''[Added in version 5.6.3]''
|}

'''[?'''&zwnj;''<s1>.<uom1>=<val1>&<s2>.<uom2>=<val2>&<s3>…''&zwnj;''']'''

Updates the ISY with the current value of one or more node status values (e.g. the current temperature, light level, etc.)

{|
|'''''nodeAddress''''' || The full address of the node (e.g. 'n005_dimmer_1')
|-
|'''''statusName, sN''''' || The name of the status value (e.g. 'ST', 'CLIHUM', etc.)
|-
|'''''value, valN''''' || The numeric status value (e.g. '80.5')
|-
|'''''uom, uomN''''' || Unit of measure of the status value
|-
|'''''text''''' || Free-form text associated with the value/uom status value (could be a description, URL, etc.)
|}

E.g.
{| style="font-family: courier;"
|/rest/ns/5/nodes/n005_dimmer_2/report/status/ST/25.2/percent
|-
|/rest/ns/5/nodes/n005_dimmer_2/report/status/ST/25.2/percent/text/A%20percentage%20status
|-
|/rest/ns/5/nodes/n005_dimmer_2/report/status?ST.percent=25.2
|-
|/rest/ns/2/nodes/n002_tstat_1/report/status/ST/68/17?CLISPC.uom17=76.5&CLISPH.uom17=64
|-
|/rest/ns/2/nodes/n002_tstat_1/report/status?ST.uom17=68&CLISPC.uom17=76.5&CLISPH.uom17=64
|}

==Reporting a command==

{|
|/'''nodes'''/''<nodeAddress>''/'''report'''/'''cmd'''/''<command>''
|-
|/'''nodes'''/''<nodeAddress>''/'''report'''/'''cmd'''/''<command>''/''<value>''
|-
|/'''nodes'''/''<nodeAddress>''/'''report'''/'''cmd'''/''<command>''/''<value>''/''<uom>''
|}

'''[?'''&zwnj;''<p1>.<uom1>=<val1>&<p2>.<uom2>=<val2>&<p3>…''&zwnj;''']'''

Sends a command to the ISY that may be used in programs and/or scenes. A common use of this is a physical switch that somebody turns on or off. Each time the switch is used, a command should be reported to the ISY. These are used for scenes and control conditions in ISY programs.

'''''Note:''''' ''Command reports are used as events that trigger control conditions in Isy programs. Currently, you cannot specifiy parameters on Isy control conditions so in most cases you will need separate commands to differentiate events.''

{|
|'''''nodeAddress''''' || The full address of the node (e.g. 'n005_switch_1)
|-
|'''''command''''' || The command to perform (e.g. 'DON', 'CLISPH', etc.)
|-
|'''''pN''''' || ''Nth'' Parameter name (e.g. 'level')
|-
|'''''uomN''''' || Unit of measure of the ''Nth'' parameter (e.g. 'seconds', 'uom58')
|-
|'''''valN''''' || The numeric value of the ''Nth'' parameter (e.g. '80', '80.01' etc,)
|}

Commands may also have an unnamed parameter
{|
|'''''value''''' || The value of the unnamed parameter.
|-
|'''''uom''''' || Unit of measure of the value of the unnamed parameter
|}

E.g.
{| style="font-family: courier;"
|/rest/ns/5/nodes/n005_switch_1/report/cmd/DON
|-
|/rest/ns/5/nodes/n005_switch_1/report/cmd/DON/80/percent
|-
|/rest/ns/5/nodes/n005_switch_1/report/cmd/DON?level.percent=80
|-
|/rest/ns/5/nodes/n005_switch_1/report/cmd/DON/80/percent?rate.uom58=0.3
|}

==Reporting ISY Request status==
{|
|/'''report'''/'''request'''/''<requestId>''/'''success'''
|-
|/'''report'''/'''request'''/''<requestId>''/'''failed'''
|-
|/'''report'''/'''request'''/''<requestId>''/'''unsupported'''
|}
When the ISY sends a request to the node server, the request may contain a ''requestId'' field.
This indicates to the node server that when the request is completed, it must send a fail or
success report for that request. This allows the ISY to in effect, have the node server
synchronously perform tasks. This message must be sent after all other messages related to the
task have been sent.

For example, if the ISY sends a request to query a node, all the results of the query must be sent
to the ISY before a fail/success/unsupported report is sent.
{|
|'''''requestId''''' || The request ID the ISY supplied on a request to the node server.
|}

E.g.
{| style="font-family: courier;"
|/rest/ns/5/report/request/1234/success
|}

==Additional REST APIs==
=== [[Polisy_Developers:ISY:API:Node_Server:Configuration#REST_API| Configuration]] ===
=== [[Polisy_Developers:ISY:API:Scene_Support:Scenes#Link_Management| Scenes]] ===
=== [[Polisy_Developers:ISY:API:System_Editors | System Editors]] ===

Polisy Developers:ISY:API:Appendix:Node Definitions

2023-08-25T17:52:26Z

Chris: Fixed formatting

[[Polisy_Developers]] : [[Polisy_Developers:ISY | ISY]] : [[Polisy_Developers:ISY:API | API]] : [[Polisy_Developers:ISY:API:Appendix | Appendix]] : Node Definitions

<nodeDefs>
<nodeDef id="Thermostat" nls="143">
<sts>
<st id="ST" editor="I_TEMP_DEG" />
<st id="CLISPH" editor="I_CLISPH_DEG" />
<st id="CLISPC" editor="I_CLISPC_DEG" />
<st id="CLIMD" editor="I_TSTAT_MODE" />
<st id="CLIHCS" editor="I_TSTAT_HCS" />
<st id="ERR" editor="I_ERR" hide="T" />
</sts>
<cmds>
<sends>
<cmd id="DON" />
<cmd id="DOF" />
</sends>
<accepts>
<cmd id="CLISPH">

</cmd>
<cmd id="CLISPC">

</cmd>
<cmd id="CLIMD">

</cmd>
<cmd id="QUERY" />
</accepts>
</cmds>
</nodeDef>
</nodeDefs>

{| border="1" style="border-collapse:collapse" cellpadding="10"
|- style="vertical-align:top;"
| rowspan="2" |'''''<nodeDef>'''''
|id || Name of this node definition (e.g. "Thermostat")
|- style="vertical-align:top;"
|nls || NLS key string used to override names of commands, status and other elements.
|- style="vertical-align:top;"
| rowspan="3" |'''''<st>'''''
|id || One of the predefined [[Polisy_Developers:ISY:API:Appendix:Status_Names | status names]] e.g. "CLISPH"
|- style="vertical-align:top;"
|editor || The id of the editor to use
|- style="vertical-align:top;"
|hide || ''(Optional)'' Set to "T" or "True", hides status in views but is available in program conditions
|- style="vertical-align:top;"
|'''''<sends>'''''
|
|The commands this node can send out. Used for control conditions in ISY programs and scene controllers.
|- style="vertical-align:top;"
|'''''<accepts>'''''
|
||The commands this node accepts. Used for buttons etc. in ISY clients, and actions in ISY programs.
|- style="vertical-align:top;"
|'''''<cmd>'''''
|id || Name of a command.
|- style="vertical-align:top;"
| rowspan="5" |''''''''''
| id || Name of a command parameter. A command may have one unnamed parameter, all others must be named.
|- style="vertical-align:top;"
| editor || The id of the editor to use for this parameter
|- style="vertical-align:top;"
| init || ''(Optional)'' id of the ''<st>'' status value this parameter should be initialized and synchronized with. For example, CLISPH is both a status and a command.
|- style="vertical-align:top;"
| optional || ''(Optional)'' Set to "T" or "True" if this is an optional parameter
|- style="vertical-align:top;"
| nls || ''(Optional)'' NLS key string used to override name of parameter.
|}

Polisy Developers:ISY:API:Appendix:Units of Measure

2023-08-25T17:46:34Z

Chris: Add uom 149,150,151

[[Polisy_Developers]] : [[Polisy_Developers:ISY | ISY]] : [[Polisy_Developers:ISY:API | API]] : [[Polisy_Developers:ISY:API:Appendix | Appendix]] : Units of Measure (UOM)

In the ISY, units of measure include the scientific units of measure as well as custom types. A unit
of measure is a numeric type that fully defines a value. Values in square brackets are keywords that
may be specified for the unit of measure instead of the numeric value when sending a request to ISY.
The ISY will always return the numeric value for the unit of measure.

Polisy
Version ID Description
0 = Unit of measure is unknown
1 = ampere (amp) '''[amp, ampere]'''
2 = boolean
3 = btu/h [btuh]
4 = celsius (C) '''[C, celsius]'''
5 = centimeter (cm) [cm]
6 = cubic feet
7 = cubic feet per minute (cfm)
8 = cubic meter
9 = day
10 = days
11 = Deadbolt status (See below)
12 = decibel (db) '''[db]'''
13 = decibel A (dbA) '''[dbA]'''
14 = generic temperature in degree
15 = Door lock alarm (See below)
16 = european macroseismic
17 = Fahrenheit (F) '''[F]'''
18 = feet
19 = hour
20 = hours
21 = absolute humidity
22 = relative humidity
23 = inches of mercury (inHg)
24 = inches/hour
25 = index
26 = kelvin (K) '''[K]'''
27 = keyword
28 = kilogram (kg) '''[kg]'''
29 = kilovolt (kV)
30 = kilowatt (kW)
31 = kilopascal (kPa) '''[kpa]'''
32 = kilometers/hour (KPH)
33 = kilowatts/hour (kWH) '''[kwh]'''
34 = liedu
35 = liter (l)
36 = lux '''[lux]'''
37 = mercalli
38 = meter (m)
39 = cubic meters/hour
40 = meters/sec (m/s)
41 = milliamp (mA)
42 = millisecond (ms)
43 = millivolt (mV)
44 = minute
45 = duration in minutes
46 = millimeters/hour (mm/hr)
47 = month (Jan=1, Feb=2, etc.)
48 = miles/hour (MPH)
49 = - Reserved -
50 = ohm '''[ohm]'''
51 = percent
52 = pound
53 = Power Factor
54 = Parts/Million (PPM)
55 = pulse count
56 = The raw value as reported by the device
57 = second
58 = Duration in seconds
59 = seimens/meter
60 = body wave magnitude scale
61 = Richter scale
62 = moment magnitude scale
63 = surface wave magnitude scale
64 = shindo
65 = SML
66 = Thermostat heat/cool state (See below)
67 = Thermostat mode (See below)
68 = Thermostat fan mode (See below)
69 = US gallon
70 = User number
71 = UV index
72 = volt '''[V, volt]'''
73 = watt '''[W, watt]'''
74 = watts/square meter
75 = weekday (Sun=0, Sat=1, etc.)
76 = Wind Direction in degrees (See below)
77 = year
78 = 0-Off 100-On, 101-Unknown
79 = 0-Open 100-Close, 101-Unknown
80 = Thermostat fan run state (See below)
81 = Thermostat fan mode override
82 = millimeter '''[mm]'''
83 = kilometer
84 = Secure Mode 0-Unlock 1-Lock
85 = Ohm Meter (Electrical resistivity)
86 = KiloOhm
87 = cubic meter/cubic meter
88 = Water activity
89 = rotations/Minute (RPM)
90 = Hertz (Hz)
91 = Angle Position degrees relative to North Pole
92 = Angle Position degrees relative to South Pole
93 = Power Management Alarm (See below)
94 = Appliance Alarm (See below)
95 = Home Health Alarm (See below)
96 = VOC Level (See below)
97 = Barrier Status (See below)
98 = Insteon Thermostat Mode (See below) - For Insteon compatibility, should use 67 (Thermostat Mode)
99 = Insteon Thermostat Fan Mode (See below) - For Insteon compatibility, should use 68 (Thermostat Fan Mode)
100 = A Level from 0-255 e.g. brightness of a dimmable lamp
101 = Degree multiplied by 2 (for Insteon compatibility) - For Insteon compatibility, should use 14 (degree)
102 = Kilowatt Second (kWs)
103 = Dollar
104 = Cents
105 = Inches
106 = Millimeters per day
107 = Raw 1-byte unsigned value
108 = Raw 2-byte unsigned value
109 = Raw 3-byte unsigned value
110 = Raw 4-byte unsigned value
111 = Raw 1-byte signed value
112 = Raw 2-byte signed value
113 = Raw 3-byte signed value
114 = Raw 4-byte signed value
115 = Most recent On style action taken for lamp control
116 = Mile
117 = Millibar (mb), typically used in barometric reports
118 = Hectopascal (hPa), typically used in barometric reports
119 = Watt Hour
120 = Inches per day
122 = Microgram per cubic meter (ug/m3)
123 = Becquerel per cubic meter (bq/m3)
124 = Picocuries per liter (pCi/l)
125 = Acidity (pH)
126 = Beats per Minute (bpm)
127 = Millimeters of mercury (for blood pressure)
128 = Joule (J)
129 = Body Mass Index (BMI)
130 = Liters per hour
131 = Decibel Milliwatts (dBm)
132 = Breaths per minute
133 = Kilohertz (kHz)
134 = Meters per squared Seconds (m/sec2)
135 = For Apparent Power, VA = Volt-Amp
136 = For Reactive Power, VAR = Volt-Amp Reactive
137 = NTP DateTime - Number of seconds since 1900
138 = Pound per square inch (PSI)
139 = 0 to 360 degrees
140 = Milligram per liter (mg/l)
141 = Newton (N)
142 = US gallons per second
143 = US gallons per minute
144 = US gallons per hour
''5.4.2'' 145 = Text
''5.4.2'' 146 = Reserved for System Editors (Do not use)
''5.6.1'' 147 = XML
''5.6.1'' 148 = Reserved for System Editors (Do not use)
''5.6.3'' 149 = 0-360 Degree of Hue
''5.6.3'' 150 = URL for streaming video/audio/etc.
''5.6.4'' 151 = Unix Timestamp

Special Values

11 = Deadbolt status
0 - Unlocked
100 - Locked
101 - Unknown
102 - Jammed

15 = Door lock alarm
1 - Master Code Changed
2 - Tamper Code Entry Limit
3 - Escutcheon Removed
4 - Key/Manually Locked
5 - Locked by Touch
6 - Key/Manually Unlocked
7 - Remote Locking Jammed Bolt
8 - Remotely Locked
9 - Remotely Unlocked
10 - Deadbolt Jammed
11 - Battery Too Low to Operate
12 - Critical Low Battery
13 - Low Battery
14 - Automatically Locked
15 - Automatic Locking Jammed Bolt
16 - Remotely Power Cycled
17 - Lock Handling Completed
19 - User Deleted
20 - User Added
21 - Duplicate PIN
22 - Jammed Bolt by Locking with Keypad
23 - Locked by Keypad
24 - Unlocked by Keypad
25 - Keypad Attempt outside Schedule
26 - Hardware Failure
27 - Factory Reset
27 = Factory Reset
28 = Manually Not Fully Locked
29 = All User Codes Deleted
30 = New User Code Not Added (Duplicate Code)
31 = Keypad Temporarily Disabled
32 = Keypad Busy
33 = New Program Code Entered
34 = RF Unlock With Invalid User Code
35 = RF Lock With Invalid User Codes
36 = Window/Door Is Open
37 = Window/Door Is Closed
38 = Window/Door Handle Is Open
39 = Window/Door Handle Is Closed
40 = User Code Entered On Keypad
41 = Power Cycled

66 = Thermostat heat/cool state
0 - Idle
1 - Heating
2 - Cooling
3 - Fan Only
4 - Pending Heat
5 - Pending Cool
6 - Vent
7 - Aux Heat
8 - 2nd Stage Heating
9 - 2nd Stage Cooling
10 - 2nd Stage Aux Heat
11 - 3rd Stage Aux Heat

67 = Thermostat mode
0 - Off
1 - Heat
2 - Cool
3 - Auto
4 - Aux/Emergency Heat
5 - Resume
6 - Fan Only
7 - Furnace
8 - Dry Air
9 - Moist Air
10 - Auto Changeover
11 - Energy Save Heat
12 - Energy Save Cool
13 - Away
14 = Program Auto
15 = Program Heat
16 = Program Cool

68 = Thermostat fan mode
0 - Auto
1 - On
2 - Auto High
3 - High
4 - Auto Medium
5 - Medium
6 - Circulation
7 - Humidity Circulation
8 = Left & Right Circulation
9 = Up & Down Circulation
10 = Quiet

76 = A 1-360 degree clockwise Wind Direction, 0 indicates no wind
0 = No Wind
90 = East
180 = South
270 = West
360 = North

80 = Thermostat fan running state
0 - Off
1 - On
2 - On High
3 - On Medium
4 - Circulation
5 - Humidity Circulation
6 - Right/Left Circulation
7 - Up/Down Circulation
8 - Quiet Circulation

93 = Power Management Alarm
1 - Power Applied
2 - Ac Mains Disconnected
3 - Ac Mains Reconnected
4 - Surge Detection
5 - Volt Drop Or Drift
6 - Over Current Detected
7 - Over Voltage Detected
8 - Over Load Detected
9 - Load Error
10 - Replace Battery Soon
11 - Replace Battery Now
12 - Battery Is Charging
13 - Battery Is Fully Charged
14 - Charge Battery Soon
15 - Charge Battery Now

94 = Appliance Alarm
1 - Program Started
2 - Program In Progress
3 - Program Completed
4 - Replace Main Filter
5 - Failure To Set Target Temperature
6 - Supplying Water
7 - Water Supply Failure
8 - Boiling
9 - Boiling Failure
10 - Washing
11 - Washing Failure
12 - Rinsing
13 - Rinsing Failure
14 - Draining
15 - Draining Failure
16 - Spinning
17 - Spinning Failure
18 - Drying
19 - Drying Failure
20 - Fan Failure
21 - Compressor Failure

95 = Home Health Alarm
1 - Leaving Bed
2 - Sitting On Bed
3 - Lying On Bed
4 - Posture Changed
5 - Sitting On Edge Of Bed

96 = VOC Level
1 - Clean
2 - Slightly Polluted
3 - Moderately Polluted
4 - Highly Polluted

97 = Barrier Status
0 - Closed
1-99 - Percent Closed (1% = almost Closed, 99% = almost Open)
100 - Open
101 - Unknown
102 - Stopped
103 - Closing
104 - Opening

98 = Insteon Thermostat mode
0 - Off
1 - Heat
2 - Cool
3 - Auto
4 - Fan Only
5 - Program Auto
6 - Program Heat
7 - Program Cool

99 = Insteon Thermostat fan mode
7 - On
8 - Auto

115 = Most recent On style action taken for lamp control
0 - On
1 - Off
2 - Fade Up
3 - Fade Down
4 - Fade Stop
5 - Fast On
6 - Fast Off
7 - Triple Press (On)
8 - Triple Press (Off)
9 - 4 x Press (On)
10 - 4 x Press (Off)
11 - 5 x Press (On)
12 - 5 x Press (Off)

Polisy Developers:ISY:API:Node Server:REST Support in ISY

2023-08-25T17:36:50Z

Chris: Assoicated text support for status values

[[Polisy_Developers | Polisy Developers]] : [[Polisy_Developers:ISY | ISY]] : [[Polisy_Developers:ISY:API | API]] : [[Polisy_Developers:ISY:API:Node_Server | Node Server]] : REST support in ISY

__TOC__

REST is an easy to use URL based command set which allows the developer to communicate with the ISY.

Unless otherwise specified, all REST commands use HTTP GET method.

See [[Polisy_Developers:ISY:API:Appendix:REST_Return_Codes | REST return codes]]

Notes:
* URL Prefix: /rest/ns/<profileNumber>/
* The profileNumber specified on the URL determines which ISY userid/password will be accepted by the ISY for the request.
* Maximum URL size is 255 bytes

==Node Management==

/'''nodes'''/''<nodeAddress>''/'''add'''/''<nodeDefId>''?'''primary'''=''<primary>''&'''name'''=''<nodeName>''[&'''nls'''=''<nlsKey>'']

Adds a node to the ISY. To make this node the primary, set ''primary'' to the same value as ''nodeAddress''

{|
|'''''nodeAddress''''' || The full address of the node (e.g. 'n005_dimmer_1')
|-
|'''''nodeDefId''''' || The id of the node definition to use for this node
|-
|'''''primary''''' || The primary node for the device this node belongs to
|-
|'''''nodeName''''' || The name of the node
|-
|'''''nls''''' || ''(Optional)'' NLS key string for information specific to this node
|}

E.g.
{| style="font-family: courier;"
|/rest/ns/5/nodes/n005_dimmer_2/add/MyDimmer?primary=n005_dimmer_1&name=Dimmer 2&nls=012B
|}

----
'''/add/nodes'''

Sends a request to the node server to have it add all of its nodes to the ISY. This API is intended for ISY clients, and is never used by a node server.

E.g.
{| style="font-family: courier;"
|/rest/ns/5/add/nodes
|}

----
/'''nodes'''/''<nodeAddress>''/'''change'''/''<nodeDefId>''[?'''nls'''=''<nlsKey>'']

Changes the node definition to use for an existing node. An example of this is may be to change a thermostat node from Fahrenheit to Celsius.
{|
|'''''nodeAddress''''' || The full address of the node (e.g. 'n005_dimmer_1')
|-
|'''''nodeDefId''''' || The id of the node definition to use for this node
|-
|'''''nls''''' || ''(Optional)'' NLS key string for information specific to this node
|}

E.g.
{| style="font-family: courier;"
|/rest/ns/5/nodes/n005_tstat_1/change/ThermostatCelsius?nls=4511
|}

----
/'''nodes'''/''<nodeAddress>''/'''remove'''

Removes a node from the ISY. A node cannot be removed if it is the primary node for at least one other node.
{|
|'''''nodeAddress''''' || The full address of the node (e.g. 'n005_dimmer_1')
|}

E.g.
{| style="font-family: courier;"
|/rest/ns/5/nodes/n005_dimmer_2/remove
|}

----
/'''nodes'''/''<nodeAddress>''/'''rename'''/''<newName>''
''(First available in Polisy 5.4.3)''

Renames an existing node.
{|
|'''''nodeAddress''''' || The full address of the node (e.g. 'n005_dimmer_1')
|-
|'''''newName''''' || The new name of the node
|}

E.g.
{| style="font-family: courier;"
|/rest/ns/5/nodes/n005_dimmer_2/rename/Kitchen Dimmer
|}

----
/'''nodes'''/''<nodeAddress>''/'''set'''/'''hint'''/''<value>''

Adds a hint to the node. This ISY stores the value with the node but does not use this value in any way.
{|
|'''''nodeAddress''''' || The full address of the node (e.g. 'n005_dimmer_1')
|-
|'''''value''''' ||A four byte integer
|}

E.g.
{| style="font-family: courier;"
|/rest/ns/5/nodes/n005_dimmer_2/set/hint/101
|}

==Reporting status updates==

{|
|/'''nodes'''/''<nodeAddress>''/'''report'''/'''status'''
|-
|/'''nodes'''/''<nodeAddress>''/'''report'''/'''status'''/''<statusName>''/''<value>''/''<uom>''
|-
|/'''nodes'''/''<nodeAddress>''/'''report'''/'''status'''/''<statusName>''/''<value>''/''<uom>''/'''text'''/''<text>'' ''[Added in version 5.6.3]''
|}

'''[?'''&zwnj;''<s1>.<uom1>=<val1>&<s2>.<uom2>=<val2>&<s3>…''&zwnj;''']'''

Updates the ISY with the current value of one or more node status values (e.g. the current temperature, light level, etc.)

{|
|'''''nodeAddress''''' || The full address of the node (e.g. 'n005_dimmer_1')
|-
|'''''statusName, sN''''' || The name of the status value (e.g. 'ST', 'CLIHUM', etc.)
|-
|'''''value, valN''''' || The numeric status value (e.g. '80.5')
|-
|'''''uom, uomN''''' || Unit of measure of the status value
|-
|'''''text''''' || Free-form text associated with the value/uom status value (could be a description, URL, etc.)
|}

E.g.
{| style="font-family: courier;"
|/rest/ns/5/nodes/n005_dimmer_2/report/status/ST/25.2/percent
|-
|/rest/ns/5/nodes/n005_dimmer_2/report/status/ST/25.2/percent/text/A%20percentage%20status
|-
|/rest/ns/5/nodes/n005_dimmer_2/report/status?ST.percent=25.2
|-
|/rest/ns/2/nodes/n002_tstat_1/report/status/ST/68/17?CLISPC.uom17=76.5&CLISPH.uom17=64
|-
|/rest/ns/2/nodes/n002_tstat_1/report/status?ST.uom17=68&CLISPC.uom17=76.5&CLISPH.uom17=64
|}

==Reporting a command==

{|
|/'''nodes'''/''<nodeAddress>''/'''report'''/'''cmd'''/''<command>''
|-
|/'''nodes'''/''<nodeAddress>''/'''report'''/'''cmd'''/''<command>''/''<value>''
|-
|/'''nodes'''/''<nodeAddress>''/'''report'''/'''cmd'''/''<command>''/''<value>''/''<uom>''
|}

'''[?'''&zwnj;''<p1>.<uom1>=<val1>&<p2>.<uom2>=<val2>&<p3>…''&zwnj;''']'''

Sends a command to the ISY that may be used in programs and/or scenes. A common use of this is a physical switch that somebody turns on or off. Each time the switch is used, a command should be reported to the ISY. These are used for scenes and control conditions in ISY programs.
{|
|'''''nodeAddress''''' || The full address of the node (e.g. 'n005_switch_1)
|-
|'''''command''''' || The command to perform (e.g. 'DON', 'CLISPH', etc.)
|-
|'''''pN''''' || ''Nth'' Parameter name (e.g. 'level')
|-
|'''''uomN''''' || Unit of measure of the ''Nth'' parameter (e.g. 'seconds', 'uom58')
|-
|'''''valN''''' || The numeric value of the ''Nth'' parameter (e.g. '80', '80.01' etc,)
|}

Commands may also have an unnamed parameter
{|
|'''''value''''' || The value of the unnamed parameter.
|-
|'''''uom''''' || Unit of measure of the value of the unnamed parameter
|}

E.g.
{| style="font-family: courier;"
|/rest/ns/5/nodes/n005_switch_1/report/cmd/DON
|-
|/rest/ns/5/nodes/n005_switch_1/report/cmd/DON/80/percent
|-
|/rest/ns/5/nodes/n005_switch_1/report/cmd/DON?level.percent=80
|-
|/rest/ns/5/nodes/n005_switch_1/report/cmd/DON/80/percent?rate.uom58=0.3
|}

==Reporting ISY Request status==
{|
|/'''report'''/'''request'''/''<requestId>''/'''success'''
|-
|/'''report'''/'''request'''/''<requestId>''/'''failed'''
|-
|/'''report'''/'''request'''/''<requestId>''/'''unsupported'''
|}
When the ISY sends a request to the node server, the request may contain a ''requestId'' field.
This indicates to the node server that when the request is completed, it must send a fail or
success report for that request. This allows the ISY to in effect, have the node server
synchronously perform tasks. This message must be sent after all other messages related to the
task have been sent.

For example, if the ISY sends a request to query a node, all the results of the query must be sent
to the ISY before a fail/success/unsupported report is sent.
{|
|'''''requestId''''' || The request ID the ISY supplied on a request to the node server.
|}

E.g.
{| style="font-family: courier;"
|/rest/ns/5/report/request/1234/success
|}

==Additional REST APIs==
=== [[Polisy_Developers:ISY:API:Node_Server:Configuration#REST_API| Configuration]] ===
=== [[Polisy_Developers:ISY:API:Scene_Support:Scenes#Link_Management| Scenes]] ===
=== [[Polisy_Developers:ISY:API:System_Editors | System Editors]] ===

Polisy Developers:ISY:API:Appendix:Units of Measure

2023-05-08T16:30:35Z

Chris: Added UOM 147,148 used by _sys_notify_full

[[Polisy_Developers]] : [[Polisy_Developers:ISY | ISY]] : [[Polisy_Developers:ISY:API | API]] : [[Polisy_Developers:ISY:API:Appendix | Appendix]] : Units of Measure (UOM)

In the ISY, units of measure include the scientific units of measure as well as custom types. A unit
of measure is a numeric type that fully defines a value. Values in square brackets are keywords that
may be specified for the unit of measure instead of the numeric value when sending a request to ISY.
The ISY will always return the numeric value for the unit of measure.

Polisy
Version ID Description
0 = Unit of measure is unknown
1 = ampere (amp) '''[amp, ampere]'''
2 = boolean
3 = btu/h [btuh]
4 = celsius (C) '''[C, celsius]'''
5 = centimeter (cm) [cm]
6 = cubic feet
7 = cubic feet per minute (cfm)
8 = cubic meter
9 = day
10 = days
11 = Deadbolt status (See below)
12 = decibel (db) '''[db]'''
13 = decibel A (dbA) '''[dbA]'''
14 = generic temperature in degree
15 = Door lock alarm (See below)
16 = european macroseismic
17 = Fahrenheit (F) '''[F]'''
18 = feet
19 = hour
20 = hours
21 = absolute humidity
22 = relative humidity
23 = inches of mercury (inHg)
24 = inches/hour
25 = index
26 = kelvin (K) '''[K]'''
27 = keyword
28 = kilogram (kg) '''[kg]'''
29 = kilovolt (kV)
30 = kilowatt (kW)
31 = kilopascal (kPa) '''[kpa]'''
32 = kilometers/hour (KPH)
33 = kilowatts/hour (kWH) '''[kwh]'''
34 = liedu
35 = liter (l)
36 = lux '''[lux]'''
37 = mercalli
38 = meter (m)
39 = cubic meters/hour
40 = meters/sec (m/s)
41 = milliamp (mA)
42 = millisecond (ms)
43 = millivolt (mV)
44 = minute
45 = duration in minutes
46 = millimeters/hour (mm/hr)
47 = month (Jan=1, Feb=2, etc.)
48 = miles/hour (MPH)
49 = - Reserved -
50 = ohm '''[ohm]'''
51 = percent
52 = pound
53 = Power Factor
54 = Parts/Million (PPM)
55 = pulse count
56 = The raw value as reported by the device
57 = second
58 = Duration in seconds
59 = seimens/meter
60 = body wave magnitude scale
61 = Richter scale
62 = moment magnitude scale
63 = surface wave magnitude scale
64 = shindo
65 = SML
66 = Thermostat heat/cool state (See below)
67 = Thermostat mode (See below)
68 = Thermostat fan mode (See below)
69 = US gallon
70 = User number
71 = UV index
72 = volt '''[V, volt]'''
73 = watt '''[W, watt]'''
74 = watts/square meter
75 = weekday (Sun=0, Sat=1, etc.)
76 = Wind Direction in degrees (See below)
77 = year
78 = 0-Off 100-On, 101-Unknown
79 = 0-Open 100-Close, 101-Unknown
80 = Thermostat fan run state (See below)
81 = Thermostat fan mode override
82 = millimeter '''[mm]'''
83 = kilometer
84 = Secure Mode 0-Unlock 1-Lock
85 = Ohm Meter (Electrical resistivity)
86 = KiloOhm
87 = cubic meter/cubic meter
88 = Water activity
89 = rotations/Minute (RPM)
90 = Hertz (Hz)
91 = Angle Position degrees relative to North Pole
92 = Angle Position degrees relative to South Pole
93 = Power Management Alarm (See below)
94 = Appliance Alarm (See below)
95 = Home Health Alarm (See below)
96 = VOC Level (See below)
97 = Barrier Status (See below)
98 = Insteon Thermostat Mode (See below) - For Insteon compatibility, should use 67 (Thermostat Mode)
99 = Insteon Thermostat Fan Mode (See below) - For Insteon compatibility, should use 68 (Thermostat Fan Mode)
100 = A Level from 0-255 e.g. brightness of a dimmable lamp
101 = Degree multiplied by 2 (for Insteon compatibility) - For Insteon compatibility, should use 14 (degree)
102 = Kilowatt Second (kWs)
103 = Dollar
104 = Cents
105 = Inches
106 = Millimeters per day
107 = Raw 1-byte unsigned value
108 = Raw 2-byte unsigned value
109 = Raw 3-byte unsigned value
110 = Raw 4-byte unsigned value
111 = Raw 1-byte signed value
112 = Raw 2-byte signed value
113 = Raw 3-byte signed value
114 = Raw 4-byte signed value
115 = Most recent On style action taken for lamp control
116 = Mile
117 = Millibar (mb), typically used in barometric reports
118 = Hectopascal (hPa), typically used in barometric reports
119 = Watt Hour
120 = Inches per day
122 = Microgram per cubic meter (ug/m3)
123 = Becquerel per cubic meter (bq/m3)
124 = Picocuries per liter (pCi/l)
125 = Acidity (pH)
126 = Beats per Minute (bpm)
127 = Millimeters of mercury (for blood pressure)
128 = Joule (J)
129 = Body Mass Index (BMI)
130 = Liters per hour
131 = Decibel Milliwatts (dBm)
132 = Breaths per minute
133 = Kilohertz (kHz)
134 = Meters per squared Seconds (m/sec2)
135 = For Apparent Power, VA = Volt-Amp
136 = For Reactive Power, VAR = Volt-Amp Reactive
137 = NTP DateTime - Number of seconds since 1900
138 = Pound per square inch (PSI)
139 = 0 to 360 degrees
140 = Milligram per liter (mg/l)
141 = Newton (N)
142 = US gallons per second
143 = US gallons per minute
144 = US gallons per hour
''5.4.2'' 145 = Text
''5.4.2'' 146 = Reserved for System Editors (Do not use)
''5.6.1'' 147 = XML
''5.6.1'' 148 = Reserved for System Editors (Do not use)

Special Values

11 = Deadbolt status
0 - Unlocked
100 - Locked
101 - Unknown
102 - Jammed

15 = Door lock alarm
1 - Master Code Changed
2 - Tamper Code Entry Limit
3 - Escutcheon Removed
4 - Key/Manually Locked
5 - Locked by Touch
6 - Key/Manually Unlocked
7 - Remote Locking Jammed Bolt
8 - Remotely Locked
9 - Remotely Unlocked
10 - Deadbolt Jammed
11 - Battery Too Low to Operate
12 - Critical Low Battery
13 - Low Battery
14 - Automatically Locked
15 - Automatic Locking Jammed Bolt
16 - Remotely Power Cycled
17 - Lock Handling Completed
19 - User Deleted
20 - User Added
21 - Duplicate PIN
22 - Jammed Bolt by Locking with Keypad
23 - Locked by Keypad
24 - Unlocked by Keypad
25 - Keypad Attempt outside Schedule
26 - Hardware Failure
27 - Factory Reset
27 = Factory Reset
28 = Manually Not Fully Locked
29 = All User Codes Deleted
30 = New User Code Not Added (Duplicate Code)
31 = Keypad Temporarily Disabled
32 = Keypad Busy
33 = New Program Code Entered
34 = RF Unlock With Invalid User Code
35 = RF Lock With Invalid User Codes
36 = Window/Door Is Open
37 = Window/Door Is Closed
38 = Window/Door Handle Is Open
39 = Window/Door Handle Is Closed
40 = User Code Entered On Keypad
41 = Power Cycled

66 = Thermostat heat/cool state
0 - Idle
1 - Heating
2 - Cooling
3 - Fan Only
4 - Pending Heat
5 - Pending Cool
6 - Vent
7 - Aux Heat
8 - 2nd Stage Heating
9 - 2nd Stage Cooling
10 - 2nd Stage Aux Heat
11 - 3rd Stage Aux Heat

67 = Thermostat mode
0 - Off
1 - Heat
2 - Cool
3 - Auto
4 - Aux/Emergency Heat
5 - Resume
6 - Fan Only
7 - Furnace
8 - Dry Air
9 - Moist Air
10 - Auto Changeover
11 - Energy Save Heat
12 - Energy Save Cool
13 - Away
14 = Program Auto
15 = Program Heat
16 = Program Cool

68 = Thermostat fan mode
0 - Auto
1 - On
2 - Auto High
3 - High
4 - Auto Medium
5 - Medium
6 - Circulation
7 - Humidity Circulation
8 = Left & Right Circulation
9 = Up & Down Circulation
10 = Quiet

76 = A 1-360 degree clockwise Wind Direction, 0 indicates no wind
0 = No Wind
90 = East
180 = South
270 = West
360 = North

80 = Thermostat fan running state
0 - Off
1 - On
2 - On High
3 - On Medium
4 - Circulation
5 - Humidity Circulation
6 - Right/Left Circulation
7 - Up/Down Circulation
8 - Quiet Circulation

93 = Power Management Alarm
1 - Power Applied
2 - Ac Mains Disconnected
3 - Ac Mains Reconnected
4 - Surge Detection
5 - Volt Drop Or Drift
6 - Over Current Detected
7 - Over Voltage Detected
8 - Over Load Detected
9 - Load Error
10 - Replace Battery Soon
11 - Replace Battery Now
12 - Battery Is Charging
13 - Battery Is Fully Charged
14 - Charge Battery Soon
15 - Charge Battery Now

94 = Appliance Alarm
1 - Program Started
2 - Program In Progress
3 - Program Completed
4 - Replace Main Filter
5 - Failure To Set Target Temperature
6 - Supplying Water
7 - Water Supply Failure
8 - Boiling
9 - Boiling Failure
10 - Washing
11 - Washing Failure
12 - Rinsing
13 - Rinsing Failure
14 - Draining
15 - Draining Failure
16 - Spinning
17 - Spinning Failure
18 - Drying
19 - Drying Failure
20 - Fan Failure
21 - Compressor Failure

95 = Home Health Alarm
1 - Leaving Bed
2 - Sitting On Bed
3 - Lying On Bed
4 - Posture Changed
5 - Sitting On Edge Of Bed

96 = VOC Level
1 - Clean
2 - Slightly Polluted
3 - Moderately Polluted
4 - Highly Polluted

97 = Barrier Status
0 - Closed
1-99 - Percent Closed (1% = almost Closed, 99% = almost Open)
100 - Open
101 - Unknown
102 - Stopped
103 - Closing
104 - Opening

98 = Insteon Thermostat mode
0 - Off
1 - Heat
2 - Cool
3 - Auto
4 - Fan Only
5 - Program Auto
6 - Program Heat
7 - Program Cool

99 = Insteon Thermostat fan mode
7 - On
8 - Auto

115 = Most recent On style action taken for lamp control
0 - On
1 - Off
2 - Fade Up
3 - Fade Down
4 - Fade Stop
5 - Fast On
6 - Fast Off
7 - Triple Press (On)
8 - Triple Press (Off)
9 - 4 x Press (On)
10 - 4 x Press (Off)
11 - 5 x Press (On)
12 - 5 x Press (Off)

Polisy Developers:ISY:API:System Editors

2023-05-07T03:53:06Z

Chris: Fixed _sys_notify_full example

[[Polisy_Developers]] : [[Polisy_Developers:ISY | ISY]] : [[Polisy_Developers:ISY:API | API]] : System Editors

== System Editors ==

System editors are [[Polisy_Developers:ISY:API:Appendix:Editors | editors]] supplied by and maintained by the ISY.

''(first available in Polisy 5.4.2)''

=== Summary ===
* In the GUI, system editors act the same as other editors
* All system editors have an id with a prefix of '''''_sys_'''''
* System editors are only allowed on command parameters (not status)

== REST API ==
Unless otherwise specified, all REST commands use HTTP GET method.

See [[Polisy_Developers:ISY:API:Appendix:REST_Return_Codes | REST return codes]]

Notes:
* URL Prefix: /rest

----
/'''system'''/'''editors'''[/''<editorId>'']

Returns all System Editors, or just the single specified System Editor.

{|
|'''''editorId'''''
| The name of the system editor, or omit to return all system editors
|-
|}

{| style="font-family: courier;"
| e.g.
|-
|/rest/system/editors
|-
|/rest/system/editors/_sys_notify_short
|}
'''Output'''
<editors>
<editor id="_sys_notify_short">
<range min="1" max="5" step="1" prec="0" uom="146">
<nls>
<e id="1">Kitchen lights</e>
<e id="2">Back door is open</e>
<e id="3">Motion in front yard</e>
<e id="4">Car is charging</e>
<e id="5">Alarm is on</e>
</nls>
</range>
</editor>
<editor id="_sys_notify_full">
<range min="1" max="5" step="1" prec="0" uom="148">
<nls>
<e id="1">Kitchen lights</e>
<e id="2">Back door is open</e>
<e id="3">Motion in front yard</e>
<e id="4">Car is charging</e>
<e id="5">Alarm is on</e>
</nls>
</range>
</editor>
</editors>
{| border="1" style="border-collapse:collapse" cellpadding="10"
|- style="vertical-align:top;"
|'''''editor'''''
|id
|The name of the system editor
|-
|'''''range'''''
|
|The set of values supported by this system editor
|-
|'''''nls'''''
|
|The list of name value pairs for this range
|-
|'''''e'''''
|id
|The id is the range value
|-
|}

== Events ==

Whenever the content for a system editor changes, the ISY will send out the following event indicating which system editor changed.

<Event SEQNUM="15" SID="uuid:33">
<control>_24</control>
<action>1</action>
<node>_sys_notify_short</node>
<eventInfo/>
</Event>

;''_sys_notify_short''
: Content changes whenever the custom notifications change in the ISY.

;''_sys_notify_full''
: Content changes whenever the custom notifications change in the ISY.

== Supported System Editors ==
=== ''_sys_notify_short'' ===

The ''_sys_notify_short'' system editor provides the list of user created custom notifications.

When a command with a parameter using the ''_sys_notify_short'' system editor is submitted to the ISY, the custom notification
it specifies is formatted by the ISY into a string as follows:
* If there is a ''subject'' in the notification then only the ''subject'' is used
* If there is no ''subject'' then the ''body'' is used
* Maximum of 80 characters are returned

The resulting string is then used as the command parameter rather than the ID of the custom notification.

e.g.

If ISY receives the following command with a parameter using ''_sys_notify_short''.
/rest/nodes/n015_t1/cmd/SHOW?GV1.'''uom146'''=2
 
Note the UOM being used is the one reserved for this system editor.

Then the ISY finds notification id=2, formats it, and sends the resulting string as follows to the node server.
/n15/nodes/n015_t1/cmd/SHOW?GV1.'''uom145'''=Hello%20World
 
Note the UOM changed to 145 (''Text'')

Could also be in this format (unnamed parameter)
/rest/nodes/n015_t1/cmd/SHOW/2/146
/n15/nodes/n015_t1/cmd/SHOW/Hello%20World/145

=== ''_sys_notify_full'' ===
''(introduced in version 5.6.1)''

The ''_sys_notify_full'' system editor provides the list of user created custom notifications.

Command parameters using the ''_sys_notify_full'' system editor cause the ISY to format the specified
notification into XML with ''subject'', ''body'', ''from'', and ''mimetype'' tags.

The resulting XML is then used as the command parameter value rather than the ID of the custom notification.

e.g.

If ISY receives the following command with a parameter using ''_sys_notify_full''.
/rest/nodes/n015_t1/cmd/SHOW?NOTIFY.'''uom148'''=3
 
Note the UOM being used is the one reserved for this system editor.

Then the ISY finds notification id=3 and formats it into XML. Rather than sending a GET request to the node server
as is normally done, the entire command is converted to XML and sent to the node server using POST.
POST /n15/nodes/n015_t1/cmd
''..header..''

<cmd id="SHOW" requestId="5">

<val '''uom="147"'''>
<![CDATA[<notification id="3"><formatted><mimetype>text/plain</mimetype><from>My Notifications</from><subject>Kitchen Motion Sensor</subject><body>The kitchen motion sensor has been triggered &lt; 10 times today.</body></formatted></notification>]]>
</val>

</cmd>
 
Note the UOM changed to 147 (''XML'')

Polisy Developers:ISY:API:System Editors

2023-05-06T20:38:43Z

Chris:

[[Polisy_Developers]] : [[Polisy_Developers:ISY | ISY]] : [[Polisy_Developers:ISY:API | API]] : System Editors

== System Editors ==

System editors are [[Polisy_Developers:ISY:API:Appendix:Editors | editors]] supplied by and maintained by the ISY.

''(first available in Polisy 5.4.2)''

=== Summary ===
* In the GUI, system editors act the same as other editors
* All system editors have an id with a prefix of '''''_sys_'''''
* System editors are only allowed on command parameters (not status)

== REST API ==
Unless otherwise specified, all REST commands use HTTP GET method.

See [[Polisy_Developers:ISY:API:Appendix:REST_Return_Codes | REST return codes]]

Notes:
* URL Prefix: /rest

----
/'''system'''/'''editors'''[/''<editorId>'']

Returns all System Editors, or just the single specified System Editor.

{|
|'''''editorId'''''
| The name of the system editor, or omit to return all system editors
|-
|}

{| style="font-family: courier;"
| e.g.
|-
|/rest/system/editors
|-
|/rest/system/editors/_sys_notify_short
|}
'''Output'''
<editors>
<editor id="_sys_notify_short">
<range min="1" max="5" step="1" prec="0" uom="146">
<nls>
<e id="1">Kitchen lights</e>
<e id="2">Back door is open</e>
<e id="3">Motion in front yard</e>
<e id="4">Car is charging</e>
<e id="5">Alarm is on</e>
</nls>
</range>
</editor>
<editor id="_sys_notify_full">
<range min="1" max="5" step="1" prec="0" uom="148">
<nls>
<e id="1">Kitchen lights</e>
<e id="2">Back door is open</e>
<e id="3">Motion in front yard</e>
<e id="4">Car is charging</e>
<e id="5">Alarm is on</e>
</nls>
</range>
</editor>
</editors>
{| border="1" style="border-collapse:collapse" cellpadding="10"
|- style="vertical-align:top;"
|'''''editor'''''
|id
|The name of the system editor
|-
|'''''range'''''
|
|The set of values supported by this system editor
|-
|'''''nls'''''
|
|The list of name value pairs for this range
|-
|'''''e'''''
|id
|The id is the range value
|-
|}

== Events ==

Whenever the content for a system editor changes, the ISY will send out the following event indicating which system editor changed.

<Event SEQNUM="15" SID="uuid:33">
<control>_24</control>
<action>1</action>
<node>_sys_notify_short</node>
<eventInfo/>
</Event>

;''_sys_notify_short''
: Content changes whenever the custom notifications change in the ISY.

;''_sys_notify_full''
: Content changes whenever the custom notifications change in the ISY.

== Supported System Editors ==
=== ''_sys_notify_short'' ===

The ''_sys_notify_short'' system editor provides the list of user created custom notifications.

When a command with a parameter using the ''_sys_notify_short'' system editor is submitted to the ISY, the custom notification
it specifies is formatted by the ISY into a string as follows:
* If there is a ''subject'' in the notification then only the ''subject'' is used
* If there is no ''subject'' then the ''body'' is used
* Maximum of 80 characters are returned

The resulting string is then used as the command parameter rather than the ID of the custom notification.

e.g.

If ISY receives the following command with a parameter using ''_sys_notify_short''.
/rest/nodes/n015_t1/cmd/SHOW?GV1.'''uom146'''=2
 
Note the UOM being used is the one reserved for this system editor.

Then the ISY finds notification id=2, formats it, and sends the resulting string as follows to the node server.
/n15/nodes/n015_t1/cmd/SHOW?GV1.'''uom145'''=Hello%20World
 
Note the UOM changed to 145 (''Text'')

Could also be in this format (unnamed parameter)
/rest/nodes/n015_t1/cmd/SHOW/2/146
/n15/nodes/n015_t1/cmd/SHOW/Hello%20World/145

=== ''_sys_notify_full'' ===
''(introduced in version 5.6.1)''

The ''_sys_notify_full'' system editor provides the list of user created custom notifications.

Command parameters using the ''_sys_notify_full'' system editor cause the ISY to format the specified
notification into XML with ''subject'', ''body'', ''from'', and ''mimetype'' tags.

The resulting XML is then used as the command parameter value rather than the ID of the custom notification.

e.g.

If ISY receives the following command with a parameter using ''_sys_notify_full''.
/rest/nodes/n015_t1/cmd/SHOW?NOTIFY.'''uom148'''=3
 
Note the UOM being used is the one reserved for this system editor.

Then the ISY finds notification id=3 and formats it into XML. Rather then sending a GET request to the node server
as is normally done, the entire command is converted to XML and sent to the node server using POST.

<cmd id="ALARM" requestId="5">

<val '''uom="147"'''>
<![CDATA[<notification id="3"><formatted><mimetype>text/plain</mimetype><from>My Notifications</from><subject>Kitchen Motion Sensor</subject><body>The kitchen motion sensor has been triggered &lt; 10 times today.</body></formatted></notification>]]>
</val>

</cmd>
 
Note the UOM changed to 147 (''XML'')

Polisy Developers:ISY:API:System Editors

2023-05-06T20:08:35Z

Chris: Added _sys_notify_full

[[Polisy_Developers]] : [[Polisy_Developers:ISY | ISY]] : [[Polisy_Developers:ISY:API | API]] : System Editors

== System Editors ==

System editors are [[Polisy_Developers:ISY:API:Appendix:Editors | editors]] supplied by and maintained by the ISY.

''(first available in Polisy 5.4.2)''

=== Summary ===
* In the GUI, system editors act the same as other editors
* All system editors have an id with a prefix of '''''_sys_'''''
* System editors are only allowed on command parameters (not status)

== REST API ==
Unless otherwise specified, all REST commands use HTTP GET method.

See [[Polisy_Developers:ISY:API:Appendix:REST_Return_Codes | REST return codes]]

Notes:
* URL Prefix: /rest

----
/'''system'''/'''editors'''[/''<editorId>'']

Returns all System Editors, or just the single specified System Editor.

{|
|'''''editorId'''''
| The name of the system editor, or omit to return all system editors
|-
|}

{| style="font-family: courier;"
| e.g.
|-
|/rest/system/editors
|-
|/rest/system/editors/_sys_notify_short
|}
'''Output'''
<editors>
<editor id="_sys_notify_short">
<range min="1" max="5" step="1" prec="0" uom="146">
<nls>
<e id="1">Kitchen lights</e>
<e id="2">Back door is open</e>
<e id="3">Motion in front yard</e>
<e id="4">Car is charging</e>
<e id="5">Alarm is on</e>
</nls>
</range>
</editor>
<editor id="_sys_notify_full">
<range min="1" max="5" step="1" prec="0" uom="148">
<nls>
<e id="1">Kitchen lights</e>
<e id="2">Back door is open</e>
<e id="3">Motion in front yard</e>
<e id="4">Car is charging</e>
<e id="5">Alarm is on</e>
</nls>
</range>
</editor>
</editors>
{| border="1" style="border-collapse:collapse" cellpadding="10"
|- style="vertical-align:top;"
|'''''editor'''''
|id
|The name of the system editor
|-
|'''''range'''''
|
|The set of values supported by this system editor
|-
|'''''nls'''''
|
|The list of name value pairs for this range
|-
|'''''e'''''
|id
|The id is the range value
|-
|}

== Events ==

Whenever the content for a system editor changes, the ISY will send out the following event indicating which system editor changed.

<Event SEQNUM="15" SID="uuid:33">
<control>_24</control>
<action>1</action>
<node>_sys_notify_short</node>
<eventInfo/>
</Event>

;''_sys_notify_short''
: Content changes whenever the custom notifications change in the ISY.

;''_sys_notify_full''
: Content changes whenever the custom notifications change in the ISY.

== Supported System Editors ==
=== ''_sys_notify_short'' ===

The ''_sys_notify_short'' system editor provides the list of user created custom notifications.

When a command with a parameter using the ''_sys_notify_short'' system editor is submitted to the ISY, the custom notification
it specifies is formatted by the ISY into a string as follows:
* If there is a ''subject'' in the notification then only the ''subject'' is used
* If there is no ''subject'' then the ''body'' is used
* Maximum of 80 characters are returned

The resulting string is then used as the command parameter rather than the ID of the custom notification.

e.g.

If ISY receives the following command with a parameter using ''_sys_notify_short''.
/rest/nodes/n015_t1/cmd/SHOW?GV1.'''uom146'''=2
 
Note the UOM being used is the one reserved for this system editor.

Then the ISY finds notification id=2, formats it, and sends the resulting string as follows to the node server.
/n15/nodes/n015_t1/cmd/SHOW?GV1.'''uom145'''=Hello%20World
 
Note the UOM changed to 145 (''Text'')

Could also be in this format (unnamed parameter)
/rest/nodes/n015_t1/cmd/SHOW/2/146
/n15/nodes/n015_t1/cmd/SHOW/Hello%20World/145

=== ''_sys_notify_full'' ===
''(introduced in version 5.6.1)''

The ''_sys_notify_full'' system editor provides the list of user created custom notifications.

Command parameters using the ''_sys_notify_full'' system editor cause the ISY to format the specified
notificiation into XML with ''subject'', ''body'', ''from'', and ''mimetype'' tags.

The resulting XML is then used as the command parameter value rather than the ID of the custom notification.

e.g.

If ISY receives the following command with a parameter using ''_sys_notify_full''.
/rest/nodes/n015_t1/cmd/SHOW?NOTIFY.'''uom148'''=3
 
Note the UOM being used is the one reserved for this system editor.

Then the ISY finds notification id=3 and formats it into XML. Rather then sending a GET request to the node server
as is normally done, the entire command is converted to XML and sent to the node server using POST.

<cmd id="ALARM" requestId="5">

<val '''uom="147"'''>
<![CDATA[<notification id="3"><formatted><mimetype>text/plain</mimetype><from>My Notifications</from><subject>Kitchen Motion Sensor</subject><body>The kitchen motion sensor has been triggered &lt; 10 times today.</body></formatted></notification>]]>
</val>

</cmd>
 
Note the UOM changed to 147 (''XML'')

Eisy:User Guide

2023-04-25T18:08:41Z

Chris: /* Can't connect to ZMatter Z-Wave board / dongle */

Welcome to our eisy corner: your one place for anything eisy!

='''Some Definitions!'''=
==ISY on Anything (IoX)==
IoX is shorthand notation for '''ISY on Anything'''. For the old timers, ISY is the code that runs on the 994, now running as an optimized and fast service on eisy and Polisy.

==Node Servers==
As you might already know, in ISY, everything is represented as a Node. These are things (or devices) that show up in your left navigation bar under ISY. A long time ago, these nodes were limited to INSTEON,X10/A10, Z-Wave, and Zigbee. Basically, protocols for which ISY994 had native support. We designed and developed node servers so that developers could integrate their things into ISY as nodes. And, hence, Node Servers: they serve nodes to ISY.

These nodes can be anything. They represent real devices such as Ring, Tesla, WiFi light bulbs, Ecobee, or they could be virtual such as calendars and climate services. Once a node is represented in ISY, then the whole ISY event based and programming environment are available to it. In short, Node Servers allow ISY to support pretty much any device or thing out there.

But, where do these node servers live? Well, you have come this far, so read on ...

==Polyglot==
Node servers have to run on some computing device. And, forcing each developer to have to come up with his/her own node server from scratch would be completely detrimental to our quest. So, we designed and developed Polyglot which is a framework that allows developers to develop their node servers with ease and confidence that all the plumbing/security and communications with ISY is handled automatically.

'''Polyglot version 3 (PG3)''' is the latest version of Polyglot which includes much enhanced functionality and, most importantly, enables the developers to charge for their node servers. PG3 is only available on eisy and Polisy. Polyglot V2 is not available on eisy.

==eisy | home ==
eisy is our own sbeautiful, powerful hardware/OS preconfigured and optimized to run Polyglot (and other things). So, for those of you non-geeks out there, we have taken all the geekiness out of Polyglot and provided you with a ready to run box. So, now that we got you excited, let's continue with setting up and using your eisy.

='''First Steps'''=

==Installation==
Installation is quite easy
* You can use UD Mobile which walks you through the setup. If not:
* Connect a Cat5e cable to eisy's Network Port and the other to your network. '''Note''': the network must initially be DHCP auto enabled
* Connect the power supply

==Accessing eisy==
IoX Launcher is the best method to find and access all of eisy's features
* Install [[Main_Page#Installing_the_Admin_Console_Icon_on_Your_Desktop | IoX Launcher]]
* Click on the row of the discovered eisy and you will see this menu
[[File:Launcher_Menu.png]]

'''Admin Console (LAN)'''
This menu item downloads the ISY Admin Console directly from eisy

'''Admin Console (Cloud)'''
This menu item downloads the ISY Admin Console from the Universal Devices cloud servers

::Regardless of how you get to the ISY Admin Console (Cloud vs. LAN), the results are the same: Admin Console is brought up and connected directly to your eisy. Admin Console allows you to add/remove/change Z-Wave/INSTEON devices, make programs, and make configuration changes. The best source for what you can do with the Admin Console is our [[Main_Page#ISY_Cookbook | ISY (994) Cookbook]].

'''Polyglot V2 (Deprecated)'''
This is not available on eisy

'''Polyglot V3 (PG3)'''
This takes you to [[eisy:User_Guide#eisy_(PG3)_Dashboard | Polyglot V3 (PG3) Dashboard]].

==Default Username and Password==
'''admin | admin''' is the default username/password for everything in eisy.

To change your password please see the [[Eisy:User_Guide#Change_Password | instructions below]].

==Setup ISY Portal for Remote Access/Alexa/GoogleHome/IFTTT==
* Please use UD Mobile which walks you through the seutp
* If you are migrating from 994, make sure you complete the [[eisy:User_Guide#Migrating_from_994_to_eisy | migration process]] from 994

Don't forget to check out all the things you can do with [[Main_Page#ISY_Portal:_Integration_with_Amazon_Echo.2FGoogle_Home.2FIFTTT | ISY Portal]].

='''Mobile App'''=
[[UD_Mobile | UD Mobile]] is everything you have ever dreamed of. It lets you control and monitor anything that's commissioned to your eisy, and it's FREE! 
UD Mobile is developed by Universal Devices. 
Forum support is available for [https://forum.universal-devices.com/forum/24-ud-mobile/ UD Mobile].

[[File:UDMobile_Featured.jpg]]

='''Device Support'''=

==Z-Wave Support==
# Simply plugin our awesome ZMatter USB dongle
# Go to the Admin Console | Configuration tab
# Check Z-Wave Support Checkbox
# Click the Save button
# Click the Reboot or Restart IoX button.
[[File:Polisy_ZWave.png]]

==Node Servers==
Pick from anything in the [[eisy:User_Guide#NodeServer_Store_Menu | Node Server Store]] and quench your thirst for integration!

==INSTEON Support==
# Connect the PLM to your eisy
eisy supports the following PLMs: 2412S, 2413S, 2413U, and 2448A7. If you have a 2413S (serial), you will need [https://www.universal-devices.com/product/serial-plm-kit/ our Serial PLM Kit]
# Go to the Admin Console | Configuration tab
# Check INSTEON Support Checkbox
# Click the Save button
# Click on the Reboot button. Here's the [[ISY-99i/ISY-26_INSTEON:How-To_Guide | INSTEON User Guide]].
[[File:Polisy_INSTEON.png]]

='''Migration'''=

==Background==
;Insteon
:The Eisy / Polisy implementation of Insteon is a port of the Insteon implementation on the ISY-994. Therefore, you will notice few if any differences.

;Z-Wave
:Our Original Z-Wave implementation is the certified version of Z-Wave on the ISY-994. This code was ported to Eisy / Polisy, but is being deprecated in favor of our new more functional implementation called ''ZMatter Z-Wave''.

:*The original implementation on Eisy / Polisy can use generic Z-Wave controllers such as the Zooz stick, or, it can use the ZMatter Z-Wave controller (either board or USB dongle).

:*The ZMatter Z-Wave implementation can only use the ZMatter Z-Wave controller (either board or USB dongle).

== What to Expect During Migration ==

; Insteon
: The Insteon network on ISY-994 will be seamlessly transferred to Eisy / Polisy. Your nodes, programs, and scenes using Insteon will remain unchanged.

; Z-Wave
: The Z-Wave network managed by ISY-994 will be migrated to the ZMatter Z-Wave implementation on Eisy / Polisy. The devices in the network will remain the same, but their representation in ISY may change.
:* Nodes
:: Z-Wave ISY Nodes will be reused whenever possible, but new nodes may be created as well.
:* Programs
:: Z-Wave ISY nodes in programs will be migrated, however, node actions and conditions may no longer be valid if the node's support for them has changed.
:* Scenes
:: Z-Wave ISY Nodes in scenes will be migrated, but those using native links (i.e. association) may require updates.

; Programs
:Programs and variables will be transferred seamlessly, but some exceptions may occur if ISY Nodes or their commands and/or status have changed.

; Network Resources
: All Network Resources will be migrated seamlessly, however, you will need to open and save each one individually.

; ISY Portal
: See [[ISY_Portal_Migrate_configurations_to_a_new_ISY | ISY Portal Migrate configurations to a new ISY]]

; Polyglot / Node Servers
: See [[Eisy:User_Guide#Migrating_Node_Servers_to_PG3x | Migrating Node Servers to PG3x]]

==Requirements==

# If you are migrating Insteon you must have a compatible PLM
#*Eisy / Polisy supports these PLMs: 2412S, 2413S, 2413U, and 2448A7
#*If you have a 2413S (serial), you will need our [https://www.universal-devices.com/product/serial-plm-kit/ Serial PLM Kit]
# If you are migrating your Z-Wave Network, you must have our [https://www.universal-devices.com/product/zmatter-usb-z-wave-matter-module-for-polisy-beta-copy/ ZMatter Z-Wave USB Dongle]
#*If you are using Polisy, you can alternatively use our [https://www.universal-devices.com/product/zmatter-z-wave-matter-module-for-polisy-beta/ ZMatter Z-Wave Board for Polisy]

== Preparing for Migration from ISY-994 ==

'''On your ISY-994'''

# Make sure the ISY-994 is upgraded to [https://forum.universal-devices.com/topic/33287-release-534-test-build-is-now-available 5.3.4],
# If you are migrating your Z-Wave network
#* You must be using a 500 Series Board in the ISY-994
#* Make a backup of your Z-Wave network (''Admin Console | Z-Wave | Backup'')
#* Make a backup of your ISY-994 (''Admin Console | File | Backup ISY'')
#* Power down your ISY-994 (very important). ISY-994 needs to be powered off because when you migrate, both your ISY-994 and Eisy / Polisy will think they are controlling the Z-Wave network.
# If you are not migrating your Z-Wave network
#* Make a backup of your ISY-994 (''Admin Console | File | Backup ISY'')

== Preparing for Migration from Eisy / Polisy ==

You can migrate locally on the same Eisy / Polisy or to another Eisy / Polisy.

'''On the Eisy / Polisy your are migrating from'''

# Make sure Eisy / Polisy is up to date
#* Go to Admin Console configuration page and select '''update packages'''
# If you are '''not''' migrating your Z-Wave network
#* Use (''Admin Console | File | Backup ISY'') to make a backup of your Eisy / Polisy
# If you are migrating your Z-Wave network
#* Leave your current Z-Wave board / dongle connected
#* Go to configuration tab in Admin Console and select "''Migrate to ZMatter Z-Wave''"
#* Choose the option that allows you to create a "migration" backup (first option)
#:* You will see a series of popup windows providing information and asking simple questions
#* Once you have your "migration" backup you are ready to migrate
#:* '''A migration backup is different than a regular backup.'''
#:* When a migration backup is restored it also migrates your Z-Wave network

== Migrating ==

'''On the Eisy / Polisy you are migrating to'''

# Do the appropriate preparation step (see above)
# Make sure Eisy / Polisy is up to date
#* Go to Admin Console configuration page and select '''update packages'''
# If you don't have a current backup, make a backup of your Eisy / Polisy (''Admin Console | File | Backup ISY'')
# If you are using Insteon, plug in the PLM
# If you are '''not''' migrating your Z-Wave network
#* Use (''Admin Console | File | Restore ISY'') to restore either your Eisy / Polisy backup or your ISY-994 backup
# If you are migrating your Z-Wave network
#* If you aren't already using it, plug in your ZMatter Z-Wave dongle and unplug any other Z-Wave dongle you may have been using.
#:* ''(Polisy only)'' If you have a ZMatter Z-Wave board then power down Polisy, add it, then power on again.
#:* Reboot Eisy / Polisy
#* Use (''Admin Console | File | Restore ISY'') to restore your "migration" backup
#:* If you are migrating from Eisy / Polisy use the migration backup (e.g. ''"ISY-'''BackupWithZWaveMigration'''.v5.5.4__Sat 2023.01.21 09.07.44 AM"'')
#:* If you are migrating from ISY-994 use your ISY-994 backup
#* When IoX restarts, it automatically does the following:
#:* Writes you Z-Wave network into the ZMatter Z-Wave controller
#:* Interviews every Z-Wave device in the Z-Wave nework, creating/updating nodes, programs and scenes.
#::* This process can take anywhere from a few seconds to a few minutes for each device depending on the complexity of the device.
#::* The best way to monitor the progress is to open the Admin Console Event Viewer to level 3
#::* For those who want lots of low-level details, you can also use this from the command line: ''tail -f /var/isy/FILES/LOG/ZWAY.LOG''
#* If you don't actually change your Z-Wave network by adding/removing Z-Wave devices after migration, you can back out the migration by connecting whatever Z-Wave dongle you were using before migration and restoring the backup you made prior to migration.
# If you are using Insteon
#* Go to the Admin Console configuration tab and make sure [[Eisy:User_Guide#INSTEON_Support | '''INSTEON Support is enabled''']] (default username/pwd = admin/admin)
#* If you are using a new PLM, [[ISY-99i/ISY-26_INSTEON:File_Menu#Restore_Modem_.28PLM.29 | '''Restore the PLM''']]
# Reconfigure any software utilizing to point to this Eisy / Polisy, restart the other software, if necessary.
# If you have ISY Portal on your 994
#* Follow [[ISY_Portal_Migrate_configurations_to_a_new_ISY | '''these instructions''']] to migrate your account, license, and Alexa/Google Home settings
#* This will also migrate all node server licenses from your Polisy to Eisy / Polisy
# If you are using Polyglot / Node Servers
#* See [[Eisy:User_Guide#Migrating_Node_Servers_to_PG3x | '''Migrating Node Servers to PG3x''']]
# If you migrated your Z-Wave Network then make a backup of it (''Z-Wave | Backup'')
# Make a backup of your newly configured IoX.

== Post Migration ==

# If you migrated your Z-Wave Network
#* If you have any Z-Wave nodes with a type of '''''(Placeholder)''''' it means the device has not been migrated yet.
#:* In most cases they are battery powered devices that were not awake during migration
#:* To migrate one of these devices, wake it up (see user manual for the device) and then do the following
#::* right+click on a placeholder node for the device, select ''Z-Wave | Synchronize | Update with Interview''
#:* When it completes do the same for the next device

==Migrating Node Servers to PG3x==
Migration is only possible with version 3.1.17 or later of PG3x. The version of PG3x that ships with eisy is currently 3.1.16 which does not support migration. Please upgrade packages first and make sure you are running version 3.1.17 of PG3x before attempting to migrate.

# Backup PG3 on Polisy.
# Restore from PG3 backup on eisy using the "Migrate from PG3 Backup" option.

Cautions:
* Node servers currently installed on eisy will be removed (and possibly replaced).
* Node servers migrated are left in the "stopped" state. You will need to manually start each one after migration.
* If the Polisy was configured to manage node servers on more than one IoX (say both Polisy IoP and i994) only one IoX will be migrated and you can't choose which one it will migrate.
* Node servers installed on the Polisy from the local node server store will likely fail to install on the eisy.
* Node server licenses should be migrated as part of the Portal migration step.

==UD Mobile==

See https://wiki.universal-devices.com/index.php?title=UD_Mobile#Migration

='''eisy (PG3) Dashboard'''=

You will be prompted with a security warning by your browser because eisy uses a self-signed certificate. Please ignore the warning.

[[File:Notsecure.png]]

You are then presented with the login screen. The default username is '''admin''' and default password is '''admin'''. Please make sure you change your default username/password once you login.

[[File:Login dialog.png]]

Once you have successfully logged into eisy, you will get the eisy Dashboard which is designed to be simple and functional.

==Change Password==

Starting with the eisy the password is managed through the Admin Console user/pass settings. Changing the '''admin''' password in Admin Console (via IoX Launcher) will update PG3x login and will keep the ISY on eisy in sync. It is no longer necessary to change the password in multiple places.

[[File:Eisy-AC-set_admin_user_and_pass1.jpg]] [[File:Eisy-AC-set_admin_user_and_pass2.jpg]]

==ISYs==

The eisy should automatically add the ISY running as '''localhost''' (or at IP 127.0.0.1) on the eisy. You can confirm this by clicking on "ISYs". It should show an ISY UUID with a checkmark next to it. Then click on "Edit Current ISY" to review/confirm information.

You can add/remove ISYs or IoXs through this menu.
# Click on the '''Add New ISY''' menu
# Fill out the entries as shown in the picture below
# Make sure you use HTTP and not HTTPS
[[File:Add_ISY.png]]

==NodeServer Store Menu==

This is where all the available node servers are listed. In order to install one of these node servers into ISY/IoX:
# Click on the name of the Node Server you wish to purchase/install
# Additional information about the Node Server will be displayed, including the purchase/install options available.

[[File:ns_purchase_options.png]]

There are 4 possible purchase options that may be available:
# Trial. Activating a trial license will make the Node Available for the trial period. When selected, the Activate button should change to an Install button.
# Free. Free Node Servers will simply show an Install button and are available to be immediately installed.
# Purchase. Clicking the Purchase button will re-direct you to the Portal purchasing system where you can purchase an license for the Node Server (see steps below).
# Subscription. Click the Purchase button for a subscription will re-direct you to the Portal purchasing system where you can purchase a license for a specific time period.

[[File:ns_purchase_info.png]]

The Purchase Info displays basic info about the node server and which ISY/IoX is currently being manages. Once you've confirmed this is what you wanted, click the Purchase button to re-direct to the Portal purchasing system. You may be asked to log-in to the Portal to complete the following steps.

[[File:ns_purchase.png]]

The Portal purchasing system will give you the option to select the type of license you wish to purchase. Use the drop down box to select the license and then click the button to continue with the payment options.

Once a node server license has been purchased, you will be re-directed back to PG3. Navigate back to the node server store and again select the node server you just purchased. The node server details page will now show an Install button instead of a Purchase button. Clicking the Install button will display the node server installation screen.

[[File:ns_install_details.png]]

If this is the first time installing this node server, you must select an empty slot before installing. If you have previously installed this node server, you will be given the option to re-install it into the slot where it is currently installed.

Once installed, it should show up in the PG3 Dashboard.

==Node Server Configuration==

Once you've installed a node server it will show up on the Dashboard. The Dashboard will show a compact view of all installed node servers.

[[File:pg3_dashboard.png]]

From the Dashboard, you can select an individual node server to configure and/or control by clicking on the 'Details' button. You can also remove node servers using the 'Delete' button.

[[File:pg3_ns_details.png]]

The node server details page starts with the status of the node server. A node server status is one of:
* "Connected" which means the node server is running and is communicating with PG3(x).
* "Disconnected" which means the node server is not running or is not communicating with PG3(x).
* "Failed" which means the node server unexpectedly stopped communicating with PG3(x), possibly it has crashed.

You will also see the version of the node server and the store from which the node server was installed.

If the node server is running, you'll see the time/date it was started and how long it has been running.

Below that is a set of buttons.

* The "Start" button will start the node server running if it is currently in the "Disconnected" or "Failed" state.
* The "Stop" button will stop the node server if it is currently in the "Connected" state.
* The "Restart" button performs a stop and then start on the node server.
* The "Load Profile" button will send the node server's profile files (node definitions) to IoX device. Normally, the node server will do this automatically so this is rarely needed.
* The "Nodes" button will switch views to show details on the nodes created by the node server.
* The "Configuration" button will switch views to show the configuration options for the node server.
* The "Log" button will show the node server's log. '''Note Check the log if you are having problems.''' There's a lot of information here about what the node server is doing.
* The "Delete" button will delete/uninstall the node server.
* The "Discover" button is optional and will only be displayed if the node server has an option to discover devices.

To configure the node server, click on the "Configuration" button. This will switch views to the Configuration view.

[[File:pg3_ns_config.png]]

The first part of the configuration lets you adjust the Poll intervals. There are two poll intervals labeled as "Short Poll" and "Long Poll". How these are actually used is node server dependent. Many node servers will use the "Short Poll" interval to make queries for status updates. The interval is in seconds. I.E. a poll interval of 60 is 60 seconds or 1 minute. The node server's Configuration Help text should explain how the node server makes use of the poll values and what values are valid for the node server.

The second part of the configuration is the configuration help text. By default, it should be shown, but can be hidden using the "Collapse Configuration Help" button. This text should explain and possibly provide examples of how to configure the node server.

Following the help text are the main configuration parameters. These are key/value pairs. The node server should provide default values here, but some node server need information that is specific to your environment in which case you may be required to enter the both the key and the value. Once you have entered the required configuration use the "Save Changes" button to save your changes.

PG3(x) also gives the node server the ability to have custom templates for parameters. These will be listed below and will prompt you for the various parameters needed.

If the node server requires configuration before it can start, it will typically provide notices that prompt you to enter the required info. These will show up on the details view like this:

[[File:pg3_ns_notices.png]]

==Purchases==
This is where all your node server purchases show up. These node servers are tied to your eisy.

='''Multi Function Button'''=
eisy's power button acts as a multifunction button

==Update and Upgrade All the Packages==
Click the button '''once'''. Please consult [https://www.universal-devices.com/my-tickets/ support] before updating this route. 
Recommended route for updating is through Admin Console -> Configuration Tab -> "Upgrade Packages" button. ‎ 
NOTE: There is not a speaker on the eisy so there will not be any beeps on reboot. 
[[File:Eisy-System-Settings.jpg]]

==Go to WIFI Setup or Leave WIFI Setup mode==
Click the button '''twice'''.

==Reset Credentials==
Click the button '''three times'''
This action resets the following passwords to the default ('''admin/admin'''): 
*SSH
*ISY on eisy(IoX) 
Be sure to change the passwords for these sections after you log-in again.

==Reset Networking==
Click the button '''4 times'''

==Reboot==
Click the button '''5 times'''

==Shutdown==
Click the button '''6 times'''

==Factory Reset==
Click the button '''10 times'''

Please wait 5 minutes after factory reset before attempting to reconnect to system. If System is not found by finder after the 5 minute wait period please reboot system by clicking the button '''5 times''' and waiting one minute for system to come online.

= Using eisy In Desktop Computer Mode =
Yes, you can use eisy as a beautiful desktop running a lean version of XFCE on FreeBSD!

== Attaching HDMI Ports ==
# Click the power button 6 times and wait for eisy to shutdown
# Attach your monitor(s) to the HDMI port(s)
# Click the power button to turn on eisy
# When you see the login prompt, login with your credentials (default = admin/admin)
# Type '''start.win''' at the prompt, accept the licenses, enter your credentials again and voila!

== Installing Development Packages ==
Registered node server developers can do node server development on eisy. It has a full set of tools to allow you to compile C/C++, run Python and Node.js, and pretty much anything you can imagine. To install development packages
* sudo udxops.sh install.dev.pkgs

Enjoy!!!

='''Troubleshooting'''=

==Can't Find eisy==
First and foremost, all VPN software block discovery of eisy on your network. As such, if you have a VPN software running, please turn it off.

If you have a modern router, eisy advertises itself as '''eisy.local''' on your network. As such, and in most cases, you should be able to find eisy at <nowiki>https://eisy.local:8443/desc</nowiki>. What you need to do is:
# In IoX Launcher, click on the '''Add''' button
# Enter '''<nowiki>https://eisy.local:8443/desc</nowiki>''' into the dialog
# Click on the '''OK''' button

If you are still having a hard time finding your eisy, it's best to check your router's DHCP client list and look for a device that has the same MAC address as the one the label at the bottom of your eisy. eisy's MAC address starts with '''00:21:b9'''.

Once you find the IP address for eisy, in this '''example''', 192.168.1.122, then
# In IoX Launcher, click on the '''Add''' button
# Enter '''<nowiki>https://192.168.1.122:8443/desc</nowiki>''' into the dialog. '''Note''' 192.168.1.122 is an example. You should use the IP address for your eisy.
# Click on the '''OK''' button

==Can't connect to ZMatter Z-Wave board / dongle==

Sometimes the USB ports need to be reset within Eisy / Polisy. The simplest way to do that is to restart Eisy / Polisy (not just IoX). This will likely solve the connection problem.

If that doesn't solve it then the problem may be due to Z-Wave network traffic. Some Z-Wave networks with a high amount of constant network traffic can prevent IoX from detecting the port being used by the ZMatter Z-Wave+ board / dongle.

The port it is using will likely be either '''cuaU0''' or '''cuaU1'''

You can override port detection by doing the following:

# Do this from a browser (if you use ''Help | About'' in Admin Console it will show your IP address e.g. something like ''192.168.0.51'')
#::http://<your_polisy>:8080/rest/zmatter/zwave/port/name/override/set/'''cuaU1'''
# You should get this back (its important you see the 200)
#::<RestResponse succeeded="true"><status>'''200'''</status></RestResponse>
# Restart IoX and it should connect to your ZMatter Z-Wave board / dongle
# If it does not connect, repeat the process but use a different port.

You can remove the override by doing the following:
#::http://<your_polisy>:8080/rest/zmatter/zwave/port/name/override/clear

==Monitor Goes Dark in Desktop Mode==
This usually happens when eisy does not have the latest BIOS. To update the BIOS, please connect an HDMI monitor + keyboard to your eisy and reboot. Once you get the login prompt:
* Login
* Type the following command
'''sudo udxops.sh update.bios'''
* Wait for the monitor to go dark at which point you need to click on the F7 button many times till you get the boot menu
* From the boot menu, choose the 2nd row
* Wait for the update to complete. Please do NOT touch anything. The unit will reboot by itself

==Upgrade Process - As of July 2022==
Please see [https://forum.universal-devices.com/topic/37257-polisy-update-process-use-admin-console-upgrade-packages-button/ this important update (July 2022)]

Unless explicitly requested by Universal Devices, '''the SSH method of updating the eisy should be avoided'''. Due to recent updates to the underlying operating system, unexpected consequences are being experienced when users force a full package upgrade and update using SSH.

You can simply click on the power button once and eisy will automatically try to upgrade itself. You don't have to reboot.

Or, if you wish to use the Admin Console: e
IoX Launcher to open the ISY Finder window.

Once logged in navigate to:
* Configuration tab
* System

Then click: “Upgrade Packages”

This updating/upgrading process through Admin Console has been developed to handle downloading the proper packages from Universal Devices servers to update UD specific libraries and dependencies needed to keep the eisy operating efficiently and as designed.

Polisy:User Guide

2023-02-06T17:47:03Z

Chris: /* Migrating from 994 to Polisy */

Welcome to our Polisy corner: your one place for anything Polisy!

'''Please see [https://forum.universal-devices.com/topic/37257-polisy-update-process-use-admin-console-upgrade-packages-button/ this important update (July 2022)]'''

='''Some Definitions!'''=
==ISY on Polisy (IoP)==
IoP is shorthand notation for '''ISY on Polisy'''. For the old timers, ISY is the code that runs on the 994, now running as an optimized and fast service on Polisy.

==Node Servers==
As you might already know, in ISY, everything is represented as a Node. These are things (or devices) that show up in your left navigation bar under ISY. A long time ago, these nodes were limited to INSTEON,X10/A10, Z-Wave, and Zigbee. Basically, protocols for which ISY994 had native support. We designed and developed node servers so that developers could integrate their things into ISY as nodes. And, hence, Node Servers: they serve nodes to ISY.

These nodes can be anything. They represent real devices such as Ring, Tesla, WiFi light bulbs, Ecobee, or they could be virtual such as calendars and climate services. Once a node is represented in ISY, then the whole ISY event based and programming environment are available to it. In short, Node Servers allow ISY to support pretty much any device or thing out there.

But, where do these node servers live? Well, you have come this far, so read on ...

==Polyglot==
Node servers have to run on some computing device. And, forcing each developer to have to come up with his/her own node server from scratch would be completely detrimental to our quest. So, we designed and developed Polyglot which is a framework that allows developers to develop their node servers with ease and confidence that all the plumbing/security and communications with ISY is handled automatically.

'''Polyglot version 3 (PG3)''' is the latest version of Polyglot which includes much enhanced functionality and, most importantly, enables the developers to charge for their node servers. PG3 is only available on Polisy.

==Polisy==
Polisy is our own shiny, beautiful, powerful hardware/OS preconfigured and optimized to run Polyglot (and other things). So, for those of you non-geeks out there, we have taken all the geekiness out of Polyglot and provided you with a ready to run box. So, now that we got you excited, let's continue with setting up and using your Polisy.

[[File:All new polisy-ANT.jpg | 600px | center]]

='''First Steps'''=

==Installation==
Installation is quite easy
* Make sure your network has DHCP auto enabled
* Connect one end of the included Cat5e cable to Polisy’s Network Port and the other to your network. You '''must''' use the port that’s closest to the '''right''' most edge of Polisy when the front of Polisy is facing you (closest to the db-9 serial port). '''Note''': the network must initially be DHCP auto enabled
* If you have the PRO version, attach the included antennas to the back of the unit.
* Connect the power supply
* Make sure the bootup sequence is as described below

==Bootup Sequence==
If this is Polisy's first bootup, please be patient as Polisy will go through an initial sequence of lights and sounds while it prepares itself for you. This process might take several minutes since it may have to update your BIOS:
* All three lights on the front light up when powered on
** If BIOS does not need to be updated, after a few seconds, only the left most stays lit for up to a minute and then, all lights turn off, you'll hear a couple of beeps
** If BIOS needs to be updated, the 2nd and 3rd light keep blinking while the BIOS is updated and the unit reboots and follows the normal process
** Everything is operational once only the left most light is lit either initially or after BIOS update
* If the 2nd or 3rd light keep blinking for more than 3 minutes, then there is an underlying issue. Please review the [[Polisy:User_Guide#Troubleshooting | Troubleshooting]] section

==Accessing Polisy==
ISY Launcher is the best method to find and access all of Polisy's features
* Install [[Main_Page#Installing_the_Admin_Console_Icon_on_Your_Desktop | ISY Launcher]]
* Click on the row of the discovered Polisy and you will see this menu
[[File:Launcher_Menu.png]]

'''Admin Console (LAN)'''
This menu item downloads the ISY Admin Console directly from Polisy

'''Admin Console (Cloud)'''
This menu item downloads the ISY Admin Console from the Universal Devices cloud servers

::Regardless of how you get to the ISY Admin Console (Cloud vs. LAN), the results are the same: Admin Console is brought up and connected directly to your Polisy. Admin Console allows you to add/remove/change Z-Wave/INSTEON devices, make programs, and make configuration changes. The best source for what you can do with the Admin Console is our [[Main_Page#ISY_Cookbook | ISY (994) Cookbook]].

'''Polyglot V2 (Deprecated)'''
This takes you to Polyglot V2 (PG2) Dashboard which allows you to add node servers (plugins for other devices) to your IoP. This site is deprecated in the favor or Polyglot V3.

'''Polyglot V3 (PG3)'''
This takes you to [[Polisy:User_Guide#Polisy_.28PG3.29_Dashboard | Polyglot V3 (PG3) Dashboard]].

==Default Username and Password==
'''admin | admin''' is the default username/password for everything in Polisy.

==Setup ISY Portal for Remote Access/Alexa/GoogleHome/IFTTT==
* Please go to [https://my.isy.io ISY Portal], register for a 30 day trial
* If you are migrating from 994, make sure you complete the [[Polisy:User_Guide#Migrating_from_994_to_Polisy | migration process]] from 994

Don't forget to check out all the things you can do with [[Main_Page#ISY_Portal:_Integration_with_Amazon_Echo.2FGoogle_Home.2FIFTTT | ISY Portal]].

='''Mobile App'''=
[[UD_Mobile | UD Mobile]] is everything you have ever dreamed of. It lets you control and monitor anything that's commissioned to your Polisy. And, it's FREE! 
UD Mobile is developed by Universal Devices. 
Forum support is available for [https://forum.universal-devices.com/forum/24-ud-mobile/ UD Mobile].

[[File:UDMobile_Featured.jpg]]

='''Device Support'''=

==Z-Wave Support==
'''Order ZMatter:
[https://www.universal-devices.com/product/zmatter-z-wave-matter-module-for-polisy-beta/ Z-Wave Plus and Matter Module''']

# Ensure that '''ZMatter''' is installed properly. [https://www.universal-devices.com/docs/ZMatter-Assembly-%20Instructions.pdf Here are the instructions]
# Go to the Admin Console | Configuration tab
# Check Z-Wave Support Checkbox
# Click the Save button
# Click on the Reboot button. Here's the [[Main_Page#Z-Wave_Plus.E2.84.A2_for_ISY-994_Series | User Guide for Z-Wave]].
[[File:Polisy_ZWave.png]]

==Node Servers==
Pick from anything in the [[Polisy:User_Guide#NodeServer_Store_Menu | Node Server Store]] and quench your thirst for integration!

==INSTEON Support==
# Connect the PLM to your Polisy
Polisy supports the following PLMs: 2412S and 2413S through the DB9 connector on the back. 2413U and [https://www.amazon.com/Insteon-2448A7-Portable-Adapter-White/dp/B0046V767Y 2448A7] through the USB port on the back. If you have a 2413S (serial), you will need [https://www.universal-devices.com/product/serial-plm-kit/ our Serial PLM Kit]
# Go to the Admin Console | Configuration tab
# Check INSTEON Support Checkbox
# Click the Save button
# Click on the Reboot button. Here's the [[ISY-99i/ISY-26_INSTEON:How-To_Guide | INSTEON User Guide]].
[[File:Polisy_INSTEON.png]]

==Migrating from 994 to Polisy==
'''Order ZMatter:
[https://www.universal-devices.com/product/zmatter-z-wave-matter-module-for-polisy-beta/ Z-Wave Plus and Matter Module''']

Use these instructions to migrate:
'''[https://wiki.universal-devices.com/index.php?title=Eisy:User_Guide#Migration Migrating from ISY-994 to Polisy or Eisy]'''

='''Polisy (PG3) Dashboard'''=

You will be prompted with a security warning by your browser because polisy uses a self-signed certificate. Please ignore the warning.

[[File:Notsecure.png]]

You are then presented with the login screen. The default username is '''admin''' and default password is '''admin'''. Please make sure you change your default username/password once you login.

[[File:Login dialog.png]]

Once you have successfully logged into Polisy, you will get the Polisy Dashboard which is designed to be simple and functional.

==ISYs==

You can add/remove ISYs or IoPs through this menu. The '''first''' thing you need to do is to add the local IoP to the list of ISYs.
# Click on the '''Add New ISY''' menu
# Fill out the entries as shown in the picture below
# Make sure you use HTTP and not HTTPS
[[File:Add_ISY.png]]

==NodeServer Store Menu==

This is where all the available node servers are listed. In order to install one of these node servers into ISY/IoP:
# Click on the name of the Node Server you wish to purchase/install
# Additional information about the Node Server will be displayed, including the purchase/install options available.

[[File:ns_purchase_options.png]]

There are 4 possible purchase options that may be available:
# Trial. Activating a trial license will make the Node Available for the trial period. When selected, the Activate button should change to an Install button.
# Free. Free Node Servers will simply show an Install button and are available to be immediately installed.
# Purchase. Clicking the Purchase button will re-direct you to the Portal purchasing system where you can purchase an license for the Node Server (see steps below).
# Subscription. Click the Purchase button for a subscription will re-direct you to the Portal purchasing system where you can purchase a license for a specific time period.

[[File:ns_purchase_info.png]]

The Purchase Info displays basic info about the node server and which ISY/IoP is currently being manages. Once you've confirmed this is what you wanted, click the Purchase button to re-direct to the Portal purchasing system. You may be asked to log-in to the Portal to complete the following steps.

[[File:ns_purchase.png]]

The Portal purchasing system will give you the option to select the type of license you wish to purchase. Use the drop down box to select the license and then click the button to continue with the payment options.

Once a node server license has been purchased, you will be re-directed back to PG3. Navigate back to the node server store and again select the node server you just purchased. The node server details page will now show an Install button instead of a Purchase button. Clicking the Install button will display the node server installation screen.

[[File:ns_install_details.png]]

If this is the first time installing this node server, you must select an empty slot before installing. If you have previously installed this node server, you will be given the option to re-install it into the slot where it is currently installed.

Once installed, it should show up in the PG3 Dashboard.

==Purchases==
This is where all your node server purchases show up. These node servers are tied to your Polisy.

='''Multi Function Button'''=
[[File:Multifunction.png|right]]

There's a little multi function button behind the very small hole on the front of the unit.
This button has multiple purposes outlined below. Every click on the button will cause the unit to beep.

If the button does not behave as described below, please [[Polisy:User_Guide#Update_Polisy | update Polisy]].

==Update and Upgrade All the Packages==
Click the button '''once'''. '''Please consult [https://www.universal-devices.com/my-tickets/ support] before updating this route. See link below for suggested update/upgrade process.'''

Please see [https://forum.universal-devices.com/topic/37257-polisy-update-process-use-admin-console-upgrade-packages-button/ this important update (July 2022)]

==Safely Reboot==
Click the button '''twice'''.

==Safely Shutdown==
Click the button '''three times'''.

==Reset Credentials==
Press and hold the button till the '''first''' LED (from the left) starts blinking then release.
This action resets the following passwords to the default ('''admin/admin'''): 
*SSH
*Polyglot v2
*ISY on Polisy (IoP) 
Be sure to change the passwords for these sections after you log-in again.

==Reset Networking==
Press and hold the button till the '''first and second''' LEDs (from the left) start blinking then release. This action resets all network configuration back to DHCP on the Ethernet jack next to the serial port. All other network interfaces shall be disabled.

==Factory Reset==
Press and hold the button till '''all''' LEDs start blinking then release. This action resets the credentials, removes all configurations from Polyglot/Polisy, and resets networking.

='''Troubleshooting'''=
==First and Foremost==
* Make sure you have connected the network cable to the '''right''' jack on the back of the unit (the right most when Polisy is facing you)
* Make sure your router is initially DHCP enabled

==Can't Find Polisy==
First and foremost, all VPN software block discovery of Polisy on your network. As such, if you have a VPN software running, please turn it off.

If you have a modern router, Polisy advertises itself as '''polisy''' on your network. As such, and in most cases, you should be able to find Polisy at <nowiki>https://polisy:8443/desc</nowiki>. What you need to do is:
# In ISY Launcher, click on the '''Add''' button
# Enter '''<nowiki>https://polisy:8443/desc</nowiki>''' into the dialog
# Click on the '''OK''' button

[[File:Add_Polisy.png]]

If you are still having a hard time finding your Polisy, it's best to check your router's DHCP client list and look for a device that has the same MAC address as the one the label at the bottom of your Polisy. Polisy's MAC address starts with '''00:0d:b9'''.

[[File:Dhclientlist.png]]

Once you find the IP address for Polisy, in this '''example''', 192.168.1.122, then
# In ISY Launcher, click on the '''Add''' button
# Enter '''<nowiki>https://192.168.1.122:8443/desc</nowiki>''' into the dialog. '''Note''' 192.168.1.122 is an example. You should use the IP address for your Polisy
# Click on the '''OK''' button

==The Second or Third Light Is Blinking==
* Signature failure
* Old BIOS
Please [https://www.universal-devices.com/my-tickets contact support].

==The Third Light Is Constantly On While Everything Else Is Off==
* This means that that flash chip is corrupted
* Request a Flash Chip from support@universal-devices.com
* Once received, unplug Polisy, open the screws on the four corners, and install it as shown in the image below
* Plug Polisy back in
* '''Immediately''' after the unit is up and while still plugged in, '''unplug the Flash Chip''', then SSH to polisy and run the following commands:
** sudo pkg update && sudo pkg upgrade and wait for completion
** sudo /usr/local/etc/udx.d/static/udxops.sh update.bios.force
** Wait for the unit to reboot

[[File:Flash.jpg]]

==Polisy OS Versions Below 13==
If the above process does not work, you will need an ssh utility (such as Putty) to connect to Polisy over the network: 
ssh admin@polisy-ip (you should change polisy-ip to the IP address of your unit). Default password is '''admin'''. Once this process is done, please change it 
Run the following commands:
* sudo uname -a 
If the OS is below 13, you have a few choices:
* '''If your Polisy is more than 2 years old'''
# You can purchase a brand new and updated SSD from [https://www.universal-devices.com/product/polisy-ssd-mpcie/ here]
# If you are a geek, you can reflash your SSD yourself. Please [https://www.universal-devices.com/my-tickets submit a ticket]
* '''If your Polisy is more than 1 and less than 2 years old'''
# Please ship to 
Universal Devices 
c/o Reflash 
5435 Balboa Blvd. 
Suite 205 
Encino, CA 91316 
Please make sure you include your return mailing address.
* '''If your Polisy is less than 1 year old''', please [https://www.universal-devices.com/my-tickets submit a ticket] and request for RMA

*Steps to change ssh password: 
:[[File:Polisy_SSH_ChangePass.jpg]] 

==Upgrade Process - As of July 2022==
Please see [https://forum.universal-devices.com/topic/37257-polisy-update-process-use-admin-console-upgrade-packages-button/ this important update (July 2022)]

Unless explicitly requested by Universal Devices, '''the SSH method of updating the Polisy should be avoided'''. Due to recent updates to the underlying operating system, unexpected consequences are being experienced when users force a full package upgrade and update using SSH.

To update/upgrade your Polisy, please only use the Admin Console to the ISY on Polisy (IoP).

Current suggested method for updating:

ISY Launcher to open the ISY Finder window.

Once logged in navigate to:
* Configuration tab
* System

Then click: “Upgrade Packages”

This updating/upgrading process through Admin Console has been developed to handle downloading the proper packages from Universal Devices servers to update UD specific libraries and dependencies needed to keep the Polisy operating efficiently and as designed.

=Cool Integrations=
This section shares interesting and useful applications of the Polisy controller submitted by our users so that others can benefit from the work already done. If you have an integration that you think other users would enjoy, please feel free to share it with us and we will work with you to add it to this section.

==Conserving Irrigation Water==
For a description of how to use Polisy to automatically adjust your landscaping watering times based upon the current weather conditions in your area, please click on the link below. This can allow you to save up to 75% on your water bill and still provide your plants with all the water they actually need.

[https://www.alphaengineeringlabs.com/gallery/Conserving%20Irrigation%20Water.pdf Conserving Irrigation Water]

==Collecting and Graphing Data==
For a description of how to use Polisy to collect data points about your house (ex: A/C run time every hour, #of minutes doors are left open, etc.) and produce a graph of data over time using Excel, please click on the link below.

[https://www.alphaengineeringlabs.com/gallery/Polisy%20Data%20Collection.pdf Collecting and Graphing Data]

==Bridging Older Serial Based Systems to Polisy==
For a description of how to use Polisy to use sensor data from an older serial-based system (an older alarm system, etc.), please click on the link below. For example, this would allow both your old alarm system and the Polisy to use the same door and window sensors that are already present on your alarm system - even though they are not Z-Wave.

[https://www.alphaengineeringlabs.com/gallery/760015xx%20Alarm%20to%20Z-Wave%20Notes.pdf Bridging Older Serial Based Systems to Polisy]

==Optimizing A/C Power Usage==
For a description of how to use Polisy to automatically adjust your A/C cooling level based upon current weather conditions and time of day to reduce your power bill and extend the life of your A/C unit, please click on the link below.

[https://www.alphaengineeringlabs.com/gallery/Optimizing%20AC%20Power%20Usage.pdf Optimizing A/C Power Usage]

==Making a Z-Wave Push Button==
It is surprisingly difficult to find a simple Z-Wave push button device to allow the user to trigger a set of actions when a button is pressed. Here is a quick guide on how to make your own push button.

[https://www.alphaengineeringlabs.com/gallery/Z-Wave%20Button.pdf Making a Z-Wave push button]

Eisy:User Guide

2023-02-03T02:10:22Z

Chris: /* Preparing for Migration from Eisy / Polisy */

Welcome to our eisy corner: your one place for anything eisy!

='''Some Definitions!'''=
==ISY on Anything (IoX)==
IoX is shorthand notation for '''ISY on Anything'''. For the old timers, ISY is the code that runs on the 994, now running as an optimized and fast service on eisy and Polisy.

==Node Servers==
As you might already know, in ISY, everything is represented as a Node. These are things (or devices) that show up in your left navigation bar under ISY. A long time ago, these nodes were limited to INSTEON,X10/A10, Z-Wave, and Zigbee. Basically, protocols for which ISY994 had native support. We designed and developed node servers so that developers could integrate their things into ISY as nodes. And, hence, Node Servers: they serve nodes to ISY.

These nodes can be anything. They represent real devices such as Ring, Tesla, WiFi light bulbs, Ecobee, or they could be virtual such as calendars and climate services. Once a node is represented in ISY, then the whole ISY event based and programming environment are available to it. In short, Node Servers allow ISY to support pretty much any device or thing out there.

But, where do these node servers live? Well, you have come this far, so read on ...

==Polyglot==
Node servers have to run on some computing device. And, forcing each developer to have to come up with his/her own node server from scratch would be completely detrimental to our quest. So, we designed and developed Polyglot which is a framework that allows developers to develop their node servers with ease and confidence that all the plumbing/security and communications with ISY is handled automatically.

'''Polyglot version 3 (PG3)''' is the latest version of Polyglot which includes much enhanced functionality and, most importantly, enables the developers to charge for their node servers. PG3 is only available on eisy and Polisy. Polyglot V2 is not available on eisy.

==eisy | home ==
eisy is our own sbeautiful, powerful hardware/OS preconfigured and optimized to run Polyglot (and other things). So, for those of you non-geeks out there, we have taken all the geekiness out of Polyglot and provided you with a ready to run box. So, now that we got you excited, let's continue with setting up and using your eisy.

='''First Steps'''=

==Installation==
Installation is quite easy
* You can use UD Mobile which walks you through the setup. If not:
* Connect a Cat5e cable to eisy's Network Port and the other to your network. '''Note''': the network must initially be DHCP auto enabled
* Connect the power supply

==Accessing eisy==
IoX Launcher is the best method to find and access all of eisy's features
* Install [[Main_Page#Installing_the_Admin_Console_Icon_on_Your_Desktop | IoX Launcher]]
* Click on the row of the discovered eisy and you will see this menu
[[File:Launcher_Menu.png]]

'''Admin Console (LAN)'''
This menu item downloads the ISY Admin Console directly from eisy

'''Admin Console (Cloud)'''
This menu item downloads the ISY Admin Console from the Universal Devices cloud servers

::Regardless of how you get to the ISY Admin Console (Cloud vs. LAN), the results are the same: Admin Console is brought up and connected directly to your eisy. Admin Console allows you to add/remove/change Z-Wave/INSTEON devices, make programs, and make configuration changes. The best source for what you can do with the Admin Console is our [[Main_Page#ISY_Cookbook | ISY (994) Cookbook]].

'''Polyglot V2 (Deprecated)'''
This is not available on eisy

'''Polyglot V3 (PG3)'''
This takes you to [[eisy:User_Guide#eisy_(PG3)_Dashboard | Polyglot V3 (PG3) Dashboard]].

==Default Username and Password==
'''admin | admin''' is the default username/password for everything in eisy.

To change your password please see the [[Eisy:User_Guide#Change_Password | instructions below]].

==Setup ISY Portal for Remote Access/Alexa/GoogleHome/IFTTT==
* Please use UD Mobile which walks you through the seutp
* If you are migrating from 994, make sure you complete the [[eisy:User_Guide#Migrating_from_994_to_eisy | migration process]] from 994

Don't forget to check out all the things you can do with [[Main_Page#ISY_Portal:_Integration_with_Amazon_Echo.2FGoogle_Home.2FIFTTT | ISY Portal]].

='''Mobile App'''=
[[UD_Mobile | UD Mobile]] is everything you have ever dreamed of. It lets you control and monitor anything that's commissioned to your eisy, and it's FREE! 
UD Mobile is developed by Universal Devices. 
Forum support is available for [https://forum.universal-devices.com/forum/24-ud-mobile/ UD Mobile].

[[File:UDMobile_Featured.jpg]]

='''Device Support'''=

==Z-Wave Support==
# Simply plugin our awesome ZMatter USB dongle
# Go to the Admin Console | Configuration tab
# Check Z-Wave Support Checkbox
# Click the Save button
# Click the Reboot or Restart IoX button.
[[File:Polisy_ZWave.png]]

==Node Servers==
Pick from anything in the [[eisy:User_Guide#NodeServer_Store_Menu | Node Server Store]] and quench your thirst for integration!

==INSTEON Support==
# Connect the PLM to your eisy
eisy supports the following PLMs: 2412S, 2413S, 2413U, and 2448A7. If you have a 2413S (serial), you will need [https://www.universal-devices.com/product/serial-plm-kit/ our Serial PLM Kit]
# Go to the Admin Console | Configuration tab
# Check INSTEON Support Checkbox
# Click the Save button
# Click on the Reboot button. Here's the [[ISY-99i/ISY-26_INSTEON:How-To_Guide | INSTEON User Guide]].
[[File:Polisy_INSTEON.png]]

='''Migration'''=

==Background==
;Insteon
:The Eisy / Polisy implementation of Insteon is a port of the Insteon implementation on the ISY-994. Therefore, you will notice few if any differences.

;Z-Wave
:Our Original Z-Wave implementation is the certified version of Z-Wave on the ISY-994. This code was ported to Eisy / Polisy, but is being deprecated in favor of our new more functional implementation called ''ZMatter Z-Wave''.

:*The original implementation on Eisy / Polisy can use generic Z-Wave controllers such as the Zooz stick, or, it can use the ZMatter Z-Wave controller (either board or USB dongle).

:*The ZMatter Z-Wave implementation can only use the ZMatter Z-Wave controller (either board or USB dongle).

== What to Expect During Migration ==

; Insteon
: The Insteon network on ISY-994 will be seamlessly transferred to Eisy / Polisy. Your nodes, programs, and scenes using Insteon will remain unchanged.

; Z-Wave
: The Z-Wave network managed by ISY-994 will be migrated to the ZMatter Z-Wave implementation on Eisy / Polisy. The devices in the network will remain the same, but their representation in ISY may change.
:* Nodes
:: Z-Wave ISY Nodes will be reused whenever possible, but new nodes may be created as well.
:* Programs
:: Z-Wave ISY nodes in programs will be migrated, however, node actions and conditions may no longer be valid if the node's support for them has changed.
:* Scenes
:: Z-Wave ISY Nodes in scenes will be migrated, but those using native links (i.e. association) may require updates.

; Programs
:Programs and variables will be transferred seamlessly, but some exceptions may occur if ISY Nodes or their commands and/or status have changed.

; Network Resources
: All Network Resources will be migrated seamlessly, however, you will need to open and save each one individually.

; ISY Portal
: See [[ISY_Portal_Migrate_configurations_to_a_new_ISY | ISY Portal Migrate configurations to a new ISY]]

; Polyglot / Node Servers
: See [[Eisy:User_Guide#Migrating_Node_Servers_to_PG3x | Migrating Node Servers to PG3x]]

==Requirements==

# If you are migrating Insteon you must have a compatible PLM
#*Eisy / Polisy supports these PLMs: 2412S, 2413S, 2413U, and 2448A7
#*If you have a 2413S (serial), you will need our [https://www.universal-devices.com/product/serial-plm-kit/ Serial PLM Kit]
# If you are migrating your Z-Wave Network, you must have our [https://www.universal-devices.com/product/zmatter-usb-z-wave-matter-module-for-polisy-beta-copy/ ZMatter Z-Wave USB Dongle]
#*If you are using Polisy, you can alternatively use our [https://www.universal-devices.com/product/zmatter-z-wave-matter-module-for-polisy-beta/ ZMatter Z-Wave Board for Polisy]

== Preparing for Migration from ISY-994 ==

'''On your ISY-994'''

# Make sure the ISY-994 is upgraded to [https://forum.universal-devices.com/topic/33287-release-534-test-build-is-now-available 5.3.4],
# If you are migrating your Z-Wave network
#* You must be using a 500 Series Board in the ISY-994
#* Make a backup of your Z-Wave network (''Admin Console | Z-Wave | Backup'')
#* Make a backup of your ISY-994 (''Admin Console | File | Backup ISY'')
#* Power down your ISY-994 (very important). ISY-994 needs to be powered off because when you migrate, both your ISY-994 and Eisy / Polisy will think they are controlling the Z-Wave network.
# If you are not migrating your Z-Wave network
#* Make a backup of your ISY-994 (''Admin Console | File | Backup ISY'')

== Preparing for Migration from Eisy / Polisy ==

You can migrate locally on the same Eisy / Polisy or to another Eisy / Polisy.

'''On the Eisy / Polisy your are migrating from'''

# Make sure Eisy / Polisy is up to date
#* Go to Admin Console configuration page and select '''update packages'''
# If you are '''not''' migrating your Z-Wave network
#* Use (''Admin Console | File | Backup ISY'') to make a backup of your Eisy / Polisy
# If you are migrating your Z-Wave network
#* Leave your current Z-Wave board / dongle connected
#* Go to configuration tab in Admin Console and select "''Migrate to ZMatter Z-Wave''"
#* Choose the option that allows you to create a "migration" backup (first option)
#:* You will see a series of popup windows providing information and asking simple questions
#* Once you have your "migration" backup you are ready to migrate
#:* '''A migration backup is different than a regular backup.'''
#:* When a migration backup is restored it also migrates your Z-Wave network

== Migrating ==

'''On the Eisy / Polisy you are migrating to'''

# Do the appropriate preparation step (see above)
# Make sure Eisy / Polisy is up to date
#* Go to Admin Console configuration page and select '''update packages'''
# If you don't have a current backup, make a backup of your Eisy / Polisy (''Admin Console | File | Backup ISY'')
# If you are using Insteon, plug in the PLM
# If you are '''not''' migrating your Z-Wave network
#* Use (''Admin Console | File | Restore ISY'') to restore either your Eisy / Polisy backup or your ISY-994 backup
# If you are migrating your Z-Wave network
#* If you aren't already using it, plug in your ZMatter Z-Wave dongle and unplug any other Z-Wave dongle you may have been using.
#:* ''(Polisy only)'' If you have a ZMatter Z-Wave board then power down Polisy, add it, then power on again.
#:* Reboot Eisy / Polisy
#* Use (''Admin Console | File | Restore ISY'') to restore your "migration" backup
#:* If you are migrating from Eisy / Polisy use the migration backup (e.g. ''"ISY-'''BackupWithZWaveMigration'''.v5.5.4__Sat 2023.01.21 09.07.44 AM"'')
#:* If you are migrating from ISY-994 use your ISY-994 backup
#* When IoX restarts, it automatically does the following:
#:* Writes you Z-Wave network into the ZMatter Z-Wave controller
#:* Interviews every Z-Wave device in the Z-Wave nework, creating/updating nodes, programs and scenes.
#::* This process can take anywhere from a few seconds to a few minutes for each device depending on the complexity of the device.
#::* The best way to monitor the progress is to open the Admin Console Event Viewer to level 3
#::* For those who want lots of low-level details, you can also use this from the command line: ''tail -f /var/isy/FILES/LOG/ZWAY.LOG''
#* If you don't actually change your Z-Wave network by adding/removing Z-Wave devices after migration, you can back out the migration by connecting whatever Z-Wave dongle you were using before migration and restoring the backup you made prior to migration.
# If you are using Insteon
#* Go to the Admin Console configuration tab and make sure [[Eisy:User_Guide#INSTEON_Support | '''INSTEON Support is enabled''']] (default username/pwd = admin/admin)
#* If you are using a new PLM, [[ISY-99i/ISY-26_INSTEON:File_Menu#Restore_Modem_.28PLM.29 | '''Restore the PLM''']]
# Reconfigure any software utilizing to point to this Eisy / Polisy, restart the other software, if necessary.
# If you have ISY Portal on your 994
#* Follow [[ISY_Portal_Migrate_configurations_to_a_new_ISY | '''these instructions''']] to migrate your account, license, and Alexa/Google Home settings
#* This will also migrate all node server licenses from your Polisy to Eisy / Polisy
# If you are using Polyglot / Node Servers
#* See [[Eisy:User_Guide#Migrating_Node_Servers_to_PG3x | '''Migrating Node Servers to PG3x''']]
# If you migrated your Z-Wave Network then make a backup of it (''Z-Wave | Backup'')
# Make a backup of your newly configured IoX.

== Post Migration ==

# If you migrated your Z-Wave Network
#* If you have any Z-Wave nodes with a type of '''''(Placeholder)''''' it means the device has not been migrated yet.
#:* In most cases they are battery powered devices that were not awake during migration
#:* To migrate one of these devices, wake it up (see user manual for the device) and then do the following
#::* right+click on a placeholder node for the device, select ''Z-Wave | Synchronize | Update with Interview''
#:* When it completes do the same for the next device

==Migrating Node Servers to PG3x==
Migration is only possible with version 3.1.17 or later of PG3x. The version of PG3x that ships with eisy is currently 3.1.16 which does not support migration. Please upgrade packages first and make sure you are running version 3.1.17 of PG3x before attempting to migrate.

# Backup PG3 on Polisy.
# Restore from PG3 backup on eisy using the "Migrate from PG3 Backup" option.

Cautions:
* Node servers currently installed on eisy will be removed (and possibly replaced).
* Node servers migrated are left in the "stopped" state. You will need to manually start each one after migration.
* If the Polisy was configured to manage node servers on more than one IoX (say both Polisy IoP and i994) only one IoX will be migrated and you can't choose which one it will migrate.
* Node servers installed on the Polisy from the local node server store will likely fail to install on the eisy.
* Node server licenses should be migrated as part of the Portal migration step.

==UD Mobile==

See https://wiki.universal-devices.com/index.php?title=UD_Mobile#Migration

='''eisy (PG3) Dashboard'''=

You will be prompted with a security warning by your browser because eisy uses a self-signed certificate. Please ignore the warning.

[[File:Notsecure.png]]

You are then presented with the login screen. The default username is '''admin''' and default password is '''admin'''. Please make sure you change your default username/password once you login.

[[File:Login dialog.png]]

Once you have successfully logged into eisy, you will get the eisy Dashboard which is designed to be simple and functional.

==Change Password==

Starting with the eisy the password is managed through the Admin Console user/pass settings. Changing the '''admin''' password in Admin Console (via IoX Launcher) will update PG3x login and will keep the ISY on eisy in sync. It is no longer necessary to change the password in multiple places.

[[File:Eisy-AC-set_admin_user_and_pass1.jpg]] [[File:Eisy-AC-set_admin_user_and_pass2.jpg]]

==ISYs==

The eisy should automatically add the ISY running as '''localhost''' (or at IP 127.0.0.1) on the eisy. You can confirm this by clicking on "ISYs". It should show an ISY UUID with a checkmark next to it. Then click on "Edit Current ISY" to review/confirm information.

You can add/remove ISYs or IoXs through this menu.
# Click on the '''Add New ISY''' menu
# Fill out the entries as shown in the picture below
# Make sure you use HTTP and not HTTPS
[[File:Add_ISY.png]]

==NodeServer Store Menu==

This is where all the available node servers are listed. In order to install one of these node servers into ISY/IoX:
# Click on the name of the Node Server you wish to purchase/install
# Additional information about the Node Server will be displayed, including the purchase/install options available.

[[File:ns_purchase_options.png]]

There are 4 possible purchase options that may be available:
# Trial. Activating a trial license will make the Node Available for the trial period. When selected, the Activate button should change to an Install button.
# Free. Free Node Servers will simply show an Install button and are available to be immediately installed.
# Purchase. Clicking the Purchase button will re-direct you to the Portal purchasing system where you can purchase an license for the Node Server (see steps below).
# Subscription. Click the Purchase button for a subscription will re-direct you to the Portal purchasing system where you can purchase a license for a specific time period.

[[File:ns_purchase_info.png]]

The Purchase Info displays basic info about the node server and which ISY/IoX is currently being manages. Once you've confirmed this is what you wanted, click the Purchase button to re-direct to the Portal purchasing system. You may be asked to log-in to the Portal to complete the following steps.

[[File:ns_purchase.png]]

The Portal purchasing system will give you the option to select the type of license you wish to purchase. Use the drop down box to select the license and then click the button to continue with the payment options.

Once a node server license has been purchased, you will be re-directed back to PG3. Navigate back to the node server store and again select the node server you just purchased. The node server details page will now show an Install button instead of a Purchase button. Clicking the Install button will display the node server installation screen.

[[File:ns_install_details.png]]

If this is the first time installing this node server, you must select an empty slot before installing. If you have previously installed this node server, you will be given the option to re-install it into the slot where it is currently installed.

Once installed, it should show up in the PG3 Dashboard.

==Purchases==
This is where all your node server purchases show up. These node servers are tied to your eisy.

='''Multi Function Button'''=
eisy's power button acts as a multifunction button

==Update and Upgrade All the Packages==
Click the button '''once'''. Please consult [https://www.universal-devices.com/my-tickets/ support] before updating this route. 
Recommended route for updating is through Admin Console -> Configuration Tab -> "Upgrade Packages" button. ‎ 
NOTE: There is not a speaker on the eisy so there will not be any beeps on reboot. 
[[File:Eisy-System-Settings.jpg]]

==Go to WIFI Setup or Leave WIFI Setup mode==
Click the button '''twice'''.

==Reset Credentials==
Click the button '''three times'''
This action resets the following passwords to the default ('''admin/admin'''): 
*SSH
*Polyglot v2
*ISY on eisy(IoX) 
Be sure to change the passwords for these sections after you log-in again.

==Reset Networking==
Click the button '''4 times'''

==Reboot==
Click the button '''5 times'''

==Shutdown==
Click the button '''6 times'''

==Factory Reset==
Click the button '''10 times'''

Please wait 5 minutes after factory reset before attempting to reconnect to system. If System is not found by finder after the 5 minute wait period please reboot system by clicking the button '''5 times''' and waiting one minute for system to come online.

= Using eisy In Desktop Computer Mode =
Yes, you can use eisy as a beautiful desktop running a lean version of XFCE on FreeBSD!

== Attaching HDMI Ports ==
# Click the power button 6 times and wait for eisy to shutdown
# Attach your monitor(s) to the HDMI port(s)
# Click the power button to turn on eisy
# When you see the login prompt, login with your credentials (default = admin/admin)
# Type '''start.win''' at the prompt, accept the licenses, enter your credentials again and voila!

== Installing Development Packages ==
You can do all your node server development on eisy. It has a full set of tools to allow you to compile C/C++, run Python and Node.js, and pretty much anything you can imagine. To install development packages
* sudo udxops.sh install.dev.pkgs
Enjoy!!!

='''Troubleshooting'''=

==Can't Find eisy==
First and foremost, all VPN software block discovery of eisy on your network. As such, if you have a VPN software running, please turn it off.

If you have a modern router, eisy advertises itself as '''eisy.local''' on your network. As such, and in most cases, you should be able to find eisy at <nowiki>https://eisy.local:8443/desc</nowiki>. What you need to do is:
# In IoX Launcher, click on the '''Add''' button
# Enter '''<nowiki>https://eisy.local:8443/desc</nowiki>''' into the dialog
# Click on the '''OK''' button

If you are still having a hard time finding your eisy, it's best to check your router's DHCP client list and look for a device that has the same MAC address as the one the label at the bottom of your eisy. eisy's MAC address starts with '''00:21:b9'''.

Once you find the IP address for eisy, in this '''example''', 192.168.1.122, then
# In IoX Launcher, click on the '''Add''' button
# Enter '''<nowiki>https://192.168.1.122:8443/desc</nowiki>''' into the dialog. '''Note''' 192.168.1.122 is an example. You should use the IP address for your eisy.
# Click on the '''OK''' button

==Can't connect to ZMatter Z-Wave board / dongle==

Sometimes the USB ports need to be reset within Eisy / Polisy. The simplest way to do that is to restart Eisy / Polisy (not just IoX). This will likely solve the connection problem.

If that doesn't solve it then the problem may be due to Z-Wave network traffic. Some Z-Wave networks with a high amount of constant network traffic can prevent IoX from detecting the port being used by the ZMatter Z-Wave+ board / dongle.

The port it is using will likely be either '''cuaU0''' or '''cuaU1'''

You can override port detection by doing the following:

# Do this from a browser (if you use ''Help | About'' in Admin Console it will show your IP address e.g. something like ''192.168.0.51'')
#::http://<your_polisy>:8080/rest/zmatter/zwave/port/name/override/set/'''cuaU1'''
# You should get this back (its important you see the 200)
#::<RestResponse succeeded="true"><status>'''200'''</status></RestResponse>
# Restart IoX and it should connect to your ZMatter Z-Wave board / dongle
# If it does not connect, repeat the process but use a different port.

==Upgrade Process - As of July 2022==
Please see [https://forum.universal-devices.com/topic/37257-polisy-update-process-use-admin-console-upgrade-packages-button/ this important update (July 2022)]

Unless explicitly requested by Universal Devices, '''the SSH method of updating the eisy should be avoided'''. Due to recent updates to the underlying operating system, unexpected consequences are being experienced when users force a full package upgrade and update using SSH.

You can simply click on the power button once and eisy will automatically try to upgrade itself. You don't have to reboot.

Or, if you wish to use the Admin Console: e
IoX Launcher to open the ISY Finder window.

Once logged in navigate to:
* Configuration tab
* System

Then click: “Upgrade Packages”

This updating/upgrading process through Admin Console has been developed to handle downloading the proper packages from Universal Devices servers to update UD specific libraries and dependencies needed to keep the eisy operating efficiently and as designed.

Eisy:User Guide

2023-02-02T02:37:04Z

Chris: /* Can't connect to ZMatter Z-Wave board / dongle */

Welcome to our eisy corner: your one place for anything eisy!

='''Some Definitions!'''=
==ISY on Anything (IoX)==
IoX is shorthand notation for '''ISY on Anything'''. For the old timers, ISY is the code that runs on the 994, now running as an optimized and fast service on eisy and Polisy.

==Node Servers==
As you might already know, in ISY, everything is represented as a Node. These are things (or devices) that show up in your left navigation bar under ISY. A long time ago, these nodes were limited to INSTEON,X10/A10, Z-Wave, and Zigbee. Basically, protocols for which ISY994 had native support. We designed and developed node servers so that developers could integrate their things into ISY as nodes. And, hence, Node Servers: they serve nodes to ISY.

These nodes can be anything. They represent real devices such as Ring, Tesla, WiFi light bulbs, Ecobee, or they could be virtual such as calendars and climate services. Once a node is represented in ISY, then the whole ISY event based and programming environment are available to it. In short, Node Servers allow ISY to support pretty much any device or thing out there.

But, where do these node servers live? Well, you have come this far, so read on ...

==Polyglot==
Node servers have to run on some computing device. And, forcing each developer to have to come up with his/her own node server from scratch would be completely detrimental to our quest. So, we designed and developed Polyglot which is a framework that allows developers to develop their node servers with ease and confidence that all the plumbing/security and communications with ISY is handled automatically.

'''Polyglot version 3 (PG3)''' is the latest version of Polyglot which includes much enhanced functionality and, most importantly, enables the developers to charge for their node servers. PG3 is only available on eisy and Polisy. Polyglot V2 is not available on eisy.

==eisy | home ==
eisy is our own sbeautiful, powerful hardware/OS preconfigured and optimized to run Polyglot (and other things). So, for those of you non-geeks out there, we have taken all the geekiness out of Polyglot and provided you with a ready to run box. So, now that we got you excited, let's continue with setting up and using your eisy.

='''First Steps'''=

==Installation==
Installation is quite easy
* You can use UD Mobile which walks you through the setup. If not:
* Connect a Cat5e cable to eisy's Network Port and the other to your network. '''Note''': the network must initially be DHCP auto enabled
* Connect the power supply

==Accessing eisy==
IoX Launcher is the best method to find and access all of eisy's features
* Install [[Main_Page#Installing_the_Admin_Console_Icon_on_Your_Desktop | IoX Launcher]]
* Click on the row of the discovered eisy and you will see this menu
[[File:Launcher_Menu.png]]

'''Admin Console (LAN)'''
This menu item downloads the ISY Admin Console directly from eisy

'''Admin Console (Cloud)'''
This menu item downloads the ISY Admin Console from the Universal Devices cloud servers

::Regardless of how you get to the ISY Admin Console (Cloud vs. LAN), the results are the same: Admin Console is brought up and connected directly to your eisy. Admin Console allows you to add/remove/change Z-Wave/INSTEON devices, make programs, and make configuration changes. The best source for what you can do with the Admin Console is our [[Main_Page#ISY_Cookbook | ISY (994) Cookbook]].

'''Polyglot V2 (Deprecated)'''
This is not available on eisy

'''Polyglot V3 (PG3)'''
This takes you to [[eisy:User_Guide#eisy_(PG3)_Dashboard | Polyglot V3 (PG3) Dashboard]].

==Default Username and Password==
'''admin | admin''' is the default username/password for everything in eisy.

To change your password please see the [[Eisy:User_Guide#Change_Password | instructions below]].

==Setup ISY Portal for Remote Access/Alexa/GoogleHome/IFTTT==
* Please use UD Mobile which walks you through the seutp
* If you are migrating from 994, make sure you complete the [[eisy:User_Guide#Migrating_from_994_to_eisy | migration process]] from 994

Don't forget to check out all the things you can do with [[Main_Page#ISY_Portal:_Integration_with_Amazon_Echo.2FGoogle_Home.2FIFTTT | ISY Portal]].

='''Mobile App'''=
[[UD_Mobile | UD Mobile]] is everything you have ever dreamed of. It lets you control and monitor anything that's commissioned to your eisy, and it's FREE! 
UD Mobile is developed by Universal Devices. 
Forum support is available for [https://forum.universal-devices.com/forum/24-ud-mobile/ UD Mobile].

[[File:UDMobile_Featured.jpg]]

='''Device Support'''=

==Z-Wave Support==
# Simply plugin our awesome ZMatter USB dongle
# Go to the Admin Console | Configuration tab
# Check Z-Wave Support Checkbox
# Click the Save button
# Click the Reboot or Restart IoX button.
[[File:Polisy_ZWave.png]]

==Node Servers==
Pick from anything in the [[eisy:User_Guide#NodeServer_Store_Menu | Node Server Store]] and quench your thirst for integration!

==INSTEON Support==
# Connect the PLM to your eisy
eisy supports the following PLMs: 2412S, 2413S, 2413U, and 2448A7. If you have a 2413S (serial), you will need [https://www.universal-devices.com/product/serial-plm-kit/ our Serial PLM Kit]
# Go to the Admin Console | Configuration tab
# Check INSTEON Support Checkbox
# Click the Save button
# Click on the Reboot button. Here's the [[ISY-99i/ISY-26_INSTEON:How-To_Guide | INSTEON User Guide]].
[[File:Polisy_INSTEON.png]]

='''Migration'''=

==Background==
;Insteon
:The Eisy / Polisy implementation of Insteon is a port of the Insteon implementation on the ISY-994. Therefore, you will notice few if any differences.

;Z-Wave
:Our Original Z-Wave implementation is the certified version of Z-Wave on the ISY-994. This code was ported to Eisy / Polisy, but is being deprecated in favor of our new more functional implementation called ''ZMatter Z-Wave''.

:*The original implementation on Eisy / Polisy can use generic Z-Wave controllers such as the Zooz stick, or, it can use the ZMatter Z-Wave controller (either board or USB dongle).

:*The ZMatter Z-Wave implementation can only use the ZMatter Z-Wave controller (either board or USB dongle).

== What to Expect During Migration ==

; Insteon
: The Insteon network on ISY-994 will be seamlessly transferred to Eisy / Polisy. Your nodes, programs, and scenes using Insteon will remain unchanged.

; Z-Wave
: The Z-Wave network managed by ISY-994 will be migrated to the ZMatter Z-Wave implementation on Eisy / Polisy. The devices in the network will remain the same, but their representation in ISY may change.
:* Nodes
:: Z-Wave ISY Nodes will be reused whenever possible, but new nodes may be created as well.
:* Programs
:: Z-Wave ISY nodes in programs will be migrated, however, node actions and conditions may no longer be valid if the node's support for them has changed.
:* Scenes
:: Z-Wave ISY Nodes in scenes will be migrated, but those using native links (i.e. association) may require updates.

; Programs
:Programs and variables will be transferred seamlessly, but some exceptions may occur if ISY Nodes or their commands and/or status have changed.

; Network Resources
: All Network Resources will be migrated seamlessly, however, you will need to open and save each one individually.

; ISY Portal
: See [[ISY_Portal_Migrate_configurations_to_a_new_ISY | ISY Portal Migrate configurations to a new ISY]]

; Polyglot / Node Servers
: See [[Eisy:User_Guide#Migrating_Node_Servers_to_PG3x | Migrating Node Servers to PG3x]]

==Requirements==

# If you are migrating Insteon you must have a compatible PLM
#*Eisy / Polisy supports these PLMs: 2412S, 2413S, 2413U, and 2448A7
#*If you have a 2413S (serial), you will need our [https://www.universal-devices.com/product/serial-plm-kit/ Serial PLM Kit]
# If you are migrating your Z-Wave Network, you must have our [https://www.universal-devices.com/product/zmatter-usb-z-wave-matter-module-for-polisy-beta-copy/ ZMatter Z-Wave USB Dongle]
#*If you are using Polisy, you can alternatively use our [https://www.universal-devices.com/product/zmatter-z-wave-matter-module-for-polisy-beta/ ZMatter Z-Wave Board for Polisy]

== Preparing for Migration from ISY-994 ==

'''On your ISY-994'''

# Make sure the ISY-994 is upgraded to [https://forum.universal-devices.com/topic/33287-release-534-test-build-is-now-available 5.3.4],
# If you are migrating your Z-Wave network
#* You must be using a 500 Series Board in the ISY-994
#* Make a backup of your Z-Wave network (''Admin Console | Z-Wave | Backup'')
#* Make a backup of your ISY-994 (''Admin Console | File | Backup ISY'')
#* Power down your ISY-994 (very important). ISY-994 needs to be powered off because when you migrate, both your ISY-994 and Eisy / Polisy will think they are controlling the Z-Wave network.
# If you are not migrating your Z-Wave network
#* Make a backup of your ISY-994 (''Admin Console | File | Backup ISY'')

== Preparing for Migration from Eisy / Polisy ==

You can migrate locally on the same Eisy / Polisy or to another Eisy / Polisy.

'''On the Eisy / Polisy your are migrating from'''

# Make sure Eisy / Polisy is up to date
#* Go to Admin Console configuration page and select '''update packages'''
# If you are '''not''' migrating your Z-Wave network
#* Use (''Admin Console | File | Backup ISY'') to make a backup of your Eisy / Polisy
# If you are migrating your Z-Wave network
#* Leave your current Z-Wave board / dongle connected
#* Go to configuration tab in Admin Console and select "''Migration ZMatter Z-Wave''"
#* Choose the option that allows you to create a "migration" backup (first option)
#:* You will see a series of popup windows providing information and asking simple questions
#* Once you have your "migration" backup you are ready to migrate
#:* '''A migration backup is different than a regular backup.'''
#:* When a migration backup is restored it also migrates your Z-Wave network

== Migrating ==

'''On the Eisy / Polisy you are migrating to'''

# Do the appropriate preparation step (see above)
# Make sure Eisy / Polisy is up to date
#* Go to Admin Console configuration page and select '''update packages'''
# If you don't have a current backup, make a backup of your Eisy / Polisy (''Admin Console | File | Backup ISY'')
# If you are using Insteon, plug in the PLM
# If you are '''not''' migrating your Z-Wave network
#* Use (''Admin Console | File | Restore ISY'') to restore either your Eisy / Polisy backup or your ISY-994 backup
# If you are migrating your Z-Wave network
#* If you aren't already using it, plug in your ZMatter Z-Wave dongle and unplug any other Z-Wave dongle you may have been using.
#:* ''(Polisy only)'' If you have a ZMatter Z-Wave board then power down Polisy, add it, then power on again.
#:* Reboot Eisy / Polisy
#* Use (''Admin Console | File | Restore ISY'') to restore your "migration" backup
#:* If you are migrating from Eisy / Polisy use the migration backup (e.g. ''"ISY-'''BackupWithZWaveMigration'''.v5.5.4__Sat 2023.01.21 09.07.44 AM"'')
#:* If you are migrating from ISY-994 use your ISY-994 backup
#* When IoX restarts, it automatically does the following:
#:* Writes you Z-Wave network into the ZMatter Z-Wave controller
#:* Interviews every Z-Wave device in the Z-Wave nework, creating/updating nodes, programs and scenes.
#::* This process can take anywhere from a few seconds to a few minutes for each device depending on the complexity of the device.
#::* The best way to monitor the progress is to open the Admin Console Event Viewer to level 3
#::* For those who want lots of low-level details, you can also use this from the command line: ''tail -f /var/isy/FILES/LOG/ZWAY.LOG''
#* If you don't actually change your Z-Wave network by adding/removing Z-Wave devices after migration, you can back out the migration by connecting whatever Z-Wave dongle you were using before migration and restoring the backup you made prior to migration.
# If you are using Insteon
#* Go to the Admin Console configuration tab and make sure [[Eisy:User_Guide#INSTEON_Support | '''INSTEON Support is enabled''']] (default username/pwd = admin/admin)
#* If you are using a new PLM, [[ISY-99i/ISY-26_INSTEON:File_Menu#Restore_Modem_.28PLM.29 | '''Restore the PLM''']]
# Reconfigure any software utilizing to point to this Eisy / Polisy, restart the other software, if necessary.
# If you have ISY Portal on your 994
#* Follow [[ISY_Portal_Migrate_configurations_to_a_new_ISY | '''these instructions''']] to migrate your account, license, and Alexa/Google Home settings
#* This will also migrate all node server licenses from your Polisy to Eisy / Polisy
# If you are using Polyglot / Node Servers
#* See [[Eisy:User_Guide#Migrating_Node_Servers_to_PG3x | '''Migrating Node Servers to PG3x''']]
# If you migrated your Z-Wave Network then make a backup of it (''Z-Wave | Backup'')
# Make a backup of your newly configured IoX.

== Post Migration ==

# If you migrated your Z-Wave Network
#* If you have any Z-Wave nodes with a type of '''''(Placeholder)''''' it means the device has not been migrated yet.
#:* In most cases they are battery powered devices that were not awake during migration
#:* To migrate one of these devices, wake it up (see user manual for the device) and then do the following
#::* right+click on a placeholder node for the device, select ''Z-Wave | Synchronize | Update with Interview''
#:* When it completes do the same for the next device

==Migrating Node Servers to PG3x==
Migration is only possible with version 3.1.17 or later of PG3x. The version of PG3x that ships with eisy is currently 3.1.16 which does not support migration. Please upgrade packages first and make sure you are running version 3.1.17 of PG3x before attempting to migrate.

# Backup PG3 on Polisy.
# Restore from PG3 backup on eisy using the "Migrate from PG3 Backup" option.

Cautions:
* Node servers currently installed on eisy will be removed (and possibly replaced).
* Node servers migrated are left in the "stopped" state. You will need to manually start each one after migration.
* If the Polisy was configured to manage node servers on more than one IoX (say both Polisy IoP and i994) only one IoX will be migrated and you can't choose which one it will migrate.
* Node servers installed on the Polisy from the local node server store will likely fail to install on the eisy.
* Node server licenses should be migrated as part of the Portal migration step.

==UD Mobile==

See https://wiki.universal-devices.com/index.php?title=UD_Mobile#Migration

='''eisy (PG3) Dashboard'''=

You will be prompted with a security warning by your browser because eisy uses a self-signed certificate. Please ignore the warning.

[[File:Notsecure.png]]

You are then presented with the login screen. The default username is '''admin''' and default password is '''admin'''. Please make sure you change your default username/password once you login.

[[File:Login dialog.png]]

Once you have successfully logged into eisy, you will get the eisy Dashboard which is designed to be simple and functional.

==Change Password==

Starting with the eisy the password is managed through the Admin Console user/pass settings. Changing the '''admin''' password in Admin Console (via IoX Launcher) will update PG3x login and will keep the ISY on eisy in sync. It is no longer necessary to change the password in multiple places.

[[File:Eisy-AC-set_admin_user_and_pass1.jpg]] [[File:Eisy-AC-set_admin_user_and_pass2.jpg]]

==ISYs==

The eisy should automatically add the ISY running as '''localhost''' (or at IP 127.0.0.1) on the eisy. You can confirm this by clicking on "ISYs". It should show an ISY UUID with a checkmark next to it. Then click on "Edit Current ISY" to review/confirm information.

You can add/remove ISYs or IoXs through this menu.
# Click on the '''Add New ISY''' menu
# Fill out the entries as shown in the picture below
# Make sure you use HTTP and not HTTPS
[[File:Add_ISY.png]]

==NodeServer Store Menu==

This is where all the available node servers are listed. In order to install one of these node servers into ISY/IoX:
# Click on the name of the Node Server you wish to purchase/install
# Additional information about the Node Server will be displayed, including the purchase/install options available.

[[File:ns_purchase_options.png]]

There are 4 possible purchase options that may be available:
# Trial. Activating a trial license will make the Node Available for the trial period. When selected, the Activate button should change to an Install button.
# Free. Free Node Servers will simply show an Install button and are available to be immediately installed.
# Purchase. Clicking the Purchase button will re-direct you to the Portal purchasing system where you can purchase an license for the Node Server (see steps below).
# Subscription. Click the Purchase button for a subscription will re-direct you to the Portal purchasing system where you can purchase a license for a specific time period.

[[File:ns_purchase_info.png]]

The Purchase Info displays basic info about the node server and which ISY/IoX is currently being manages. Once you've confirmed this is what you wanted, click the Purchase button to re-direct to the Portal purchasing system. You may be asked to log-in to the Portal to complete the following steps.

[[File:ns_purchase.png]]

The Portal purchasing system will give you the option to select the type of license you wish to purchase. Use the drop down box to select the license and then click the button to continue with the payment options.

Once a node server license has been purchased, you will be re-directed back to PG3. Navigate back to the node server store and again select the node server you just purchased. The node server details page will now show an Install button instead of a Purchase button. Clicking the Install button will display the node server installation screen.

[[File:ns_install_details.png]]

If this is the first time installing this node server, you must select an empty slot before installing. If you have previously installed this node server, you will be given the option to re-install it into the slot where it is currently installed.

Once installed, it should show up in the PG3 Dashboard.

==Purchases==
This is where all your node server purchases show up. These node servers are tied to your eisy.

='''Multi Function Button'''=
eisy's power button acts as a multifunction button

==Update and Upgrade All the Packages==
Click the button '''once'''. Please consult [https://www.universal-devices.com/my-tickets/ support] before updating this route. 
Recommended route for updating is through Admin Console -> Configuration Tab -> "Upgrade Packages" button. ‎ 
NOTE: There is not a speaker on the eisy so there will not be any beeps on reboot. 
[[File:Eisy-System-Settings.jpg]]

==Go to WIFI Setup or Leave WIFI Setup mode==
Click the button '''twice'''.

==Reset Credentials==
Click the button '''three times'''
This action resets the following passwords to the default ('''admin/admin'''): 
*SSH
*Polyglot v2
*ISY on eisy(IoX) 
Be sure to change the passwords for these sections after you log-in again.

==Reset Networking==
Click the button '''4 times'''

==Reboot==
Click the button '''5 times'''

==Shutdown==
Click the button '''6 times'''

==Factory Reset==
Click the button '''10 times'''

Please wait 5 minutes after factory reset before attempting to reconnect to system. If System is not found by finder after the 5 minute wait period please reboot system by clicking the button '''5 times''' and waiting one minute for system to come online.

= Using eisy In Desktop Computer Mode =
Yes, you can use eisy as a beautiful desktop running a lean version of XFCE on FreeBSD!

== Attaching HDMI Ports ==
# Click the power button 6 times and wait for eisy to shutdown
# Attach your monitor(s) to the HDMI port(s)
# Click the power button to turn on eisy
# When you see the login prompt, login with your credentials (default = admin/admin)
# Type '''start.win''' at the prompt, accept the licenses, enter your credentials again and voila!

== Installing Development Packages ==
You can do all your node server development on eisy. It has a full set of tools to allow you to compile C/C++, run Python and Node.js, and pretty much anything you can imagine. To install development packages
* sudo udxops.sh install.dev.pkgs
Enjoy!!!

='''Troubleshooting'''=

==Can't Find eisy==
First and foremost, all VPN software block discovery of eisy on your network. As such, if you have a VPN software running, please turn it off.

If you have a modern router, eisy advertises itself as '''eisy.local''' on your network. As such, and in most cases, you should be able to find eisy at <nowiki>https://eisy.local:8443/desc</nowiki>. What you need to do is:
# In IoX Launcher, click on the '''Add''' button
# Enter '''<nowiki>https://eisy.local:8443/desc</nowiki>''' into the dialog
# Click on the '''OK''' button

If you are still having a hard time finding your eisy, it's best to check your router's DHCP client list and look for a device that has the same MAC address as the one the label at the bottom of your eisy. eisy's MAC address starts with '''00:21:b9'''.

Once you find the IP address for eisy, in this '''example''', 192.168.1.122, then
# In IoX Launcher, click on the '''Add''' button
# Enter '''<nowiki>https://192.168.1.122:8443/desc</nowiki>''' into the dialog. '''Note''' 192.168.1.122 is an example. You should use the IP address for your eisy.
# Click on the '''OK''' button

==Can't connect to ZMatter Z-Wave board / dongle==

Sometimes the USB ports need to be reset within Eisy / Polisy. The simplest way to do that is to restart Eisy / Polisy (not just IoX). This will likely solve the connection problem.

If that doesn't solve it then the problem may be due to Z-Wave network traffic. Some Z-Wave networks with a high amount of constant network traffic can prevent IoX from detecting the port being used by the ZMatter Z-Wave+ board / dongle.

The port it is using will likely be either '''cuaU0''' or '''cuaU1'''

You can override port detection by doing the following:

# Do this from a browser (if you use ''Help | About'' in Admin Console it will show your IP address e.g. something like ''192.168.0.51'')
#::http://<your_polisy>:8080/rest/zmatter/zwave/port/name/override/set/'''cuaU1'''
# You should get this back (its important you see the 200)
#::<RestResponse succeeded="true"><status>'''200'''</status></RestResponse>
# Restart IoX and it should connect to your ZMatter Z-Wave board / dongle
# If it does not connect, repeat the process but use a different port.

==Upgrade Process - As of July 2022==
Please see [https://forum.universal-devices.com/topic/37257-polisy-update-process-use-admin-console-upgrade-packages-button/ this important update (July 2022)]

Unless explicitly requested by Universal Devices, '''the SSH method of updating the eisy should be avoided'''. Due to recent updates to the underlying operating system, unexpected consequences are being experienced when users force a full package upgrade and update using SSH.

You can simply click on the power button once and eisy will automatically try to upgrade itself. You don't have to reboot.

Or, if you wish to use the Admin Console: e
IoX Launcher to open the ISY Finder window.

Once logged in navigate to:
* Configuration tab
* System

Then click: “Upgrade Packages”

This updating/upgrading process through Admin Console has been developed to handle downloading the proper packages from Universal Devices servers to update UD specific libraries and dependencies needed to keep the eisy operating efficiently and as designed.

Eisy:User Guide

2023-02-02T02:26:40Z

Chris: /* Migrating */

Welcome to our eisy corner: your one place for anything eisy!

='''Some Definitions!'''=
==ISY on Anything (IoX)==
IoX is shorthand notation for '''ISY on Anything'''. For the old timers, ISY is the code that runs on the 994, now running as an optimized and fast service on eisy and Polisy.

==Node Servers==
As you might already know, in ISY, everything is represented as a Node. These are things (or devices) that show up in your left navigation bar under ISY. A long time ago, these nodes were limited to INSTEON,X10/A10, Z-Wave, and Zigbee. Basically, protocols for which ISY994 had native support. We designed and developed node servers so that developers could integrate their things into ISY as nodes. And, hence, Node Servers: they serve nodes to ISY.

These nodes can be anything. They represent real devices such as Ring, Tesla, WiFi light bulbs, Ecobee, or they could be virtual such as calendars and climate services. Once a node is represented in ISY, then the whole ISY event based and programming environment are available to it. In short, Node Servers allow ISY to support pretty much any device or thing out there.

But, where do these node servers live? Well, you have come this far, so read on ...

==Polyglot==
Node servers have to run on some computing device. And, forcing each developer to have to come up with his/her own node server from scratch would be completely detrimental to our quest. So, we designed and developed Polyglot which is a framework that allows developers to develop their node servers with ease and confidence that all the plumbing/security and communications with ISY is handled automatically.

'''Polyglot version 3 (PG3)''' is the latest version of Polyglot which includes much enhanced functionality and, most importantly, enables the developers to charge for their node servers. PG3 is only available on eisy and Polisy. Polyglot V2 is not available on eisy.

==eisy | home ==
eisy is our own sbeautiful, powerful hardware/OS preconfigured and optimized to run Polyglot (and other things). So, for those of you non-geeks out there, we have taken all the geekiness out of Polyglot and provided you with a ready to run box. So, now that we got you excited, let's continue with setting up and using your eisy.

='''First Steps'''=

==Installation==
Installation is quite easy
* You can use UD Mobile which walks you through the setup. If not:
* Connect a Cat5e cable to eisy's Network Port and the other to your network. '''Note''': the network must initially be DHCP auto enabled
* Connect the power supply

==Accessing eisy==
IoX Launcher is the best method to find and access all of eisy's features
* Install [[Main_Page#Installing_the_Admin_Console_Icon_on_Your_Desktop | IoX Launcher]]
* Click on the row of the discovered eisy and you will see this menu
[[File:Launcher_Menu.png]]

'''Admin Console (LAN)'''
This menu item downloads the ISY Admin Console directly from eisy

'''Admin Console (Cloud)'''
This menu item downloads the ISY Admin Console from the Universal Devices cloud servers

::Regardless of how you get to the ISY Admin Console (Cloud vs. LAN), the results are the same: Admin Console is brought up and connected directly to your eisy. Admin Console allows you to add/remove/change Z-Wave/INSTEON devices, make programs, and make configuration changes. The best source for what you can do with the Admin Console is our [[Main_Page#ISY_Cookbook | ISY (994) Cookbook]].

'''Polyglot V2 (Deprecated)'''
This is not available on eisy

'''Polyglot V3 (PG3)'''
This takes you to [[eisy:User_Guide#eisy_(PG3)_Dashboard | Polyglot V3 (PG3) Dashboard]].

==Default Username and Password==
'''admin | admin''' is the default username/password for everything in eisy.

To change your password please see the [[Eisy:User_Guide#Change_Password | instructions below]].

==Setup ISY Portal for Remote Access/Alexa/GoogleHome/IFTTT==
* Please use UD Mobile which walks you through the seutp
* If you are migrating from 994, make sure you complete the [[eisy:User_Guide#Migrating_from_994_to_eisy | migration process]] from 994

Don't forget to check out all the things you can do with [[Main_Page#ISY_Portal:_Integration_with_Amazon_Echo.2FGoogle_Home.2FIFTTT | ISY Portal]].

='''Mobile App'''=
[[UD_Mobile | UD Mobile]] is everything you have ever dreamed of. It lets you control and monitor anything that's commissioned to your eisy, and it's FREE! 
UD Mobile is developed by Universal Devices. 
Forum support is available for [https://forum.universal-devices.com/forum/24-ud-mobile/ UD Mobile].

[[File:UDMobile_Featured.jpg]]

='''Device Support'''=

==Z-Wave Support==
# Simply plugin our awesome ZMatter USB dongle
# Go to the Admin Console | Configuration tab
# Check Z-Wave Support Checkbox
# Click the Save button
# Click the Reboot or Restart IoX button.
[[File:Polisy_ZWave.png]]

==Node Servers==
Pick from anything in the [[eisy:User_Guide#NodeServer_Store_Menu | Node Server Store]] and quench your thirst for integration!

==INSTEON Support==
# Connect the PLM to your eisy
eisy supports the following PLMs: 2412S, 2413S, 2413U, and 2448A7. If you have a 2413S (serial), you will need [https://www.universal-devices.com/product/serial-plm-kit/ our Serial PLM Kit]
# Go to the Admin Console | Configuration tab
# Check INSTEON Support Checkbox
# Click the Save button
# Click on the Reboot button. Here's the [[ISY-99i/ISY-26_INSTEON:How-To_Guide | INSTEON User Guide]].
[[File:Polisy_INSTEON.png]]

='''Migration'''=

==Background==
;Insteon
:The Eisy / Polisy implementation of Insteon is a port of the Insteon implementation on the ISY-994. Therefore, you will notice few if any differences.

;Z-Wave
:Our Original Z-Wave implementation is the certified version of Z-Wave on the ISY-994. This code was ported to Eisy / Polisy, but is being deprecated in favor of our new more functional implementation called ''ZMatter Z-Wave''.

:*The original implementation on Eisy / Polisy can use generic Z-Wave controllers such as the Zooz stick, or, it can use the ZMatter Z-Wave controller (either board or USB dongle).

:*The ZMatter Z-Wave implementation can only use the ZMatter Z-Wave controller (either board or USB dongle).

== What to Expect During Migration ==

; Insteon
: The Insteon network on ISY-994 will be seamlessly transferred to Eisy / Polisy. Your nodes, programs, and scenes using Insteon will remain unchanged.

; Z-Wave
: The Z-Wave network managed by ISY-994 will be migrated to the ZMatter Z-Wave implementation on Eisy / Polisy. The devices in the network will remain the same, but their representation in ISY may change.
:* Nodes
:: Z-Wave ISY Nodes will be reused whenever possible, but new nodes may be created as well.
:* Programs
:: Z-Wave ISY nodes in programs will be migrated, however, node actions and conditions may no longer be valid if the node's support for them has changed.
:* Scenes
:: Z-Wave ISY Nodes in scenes will be migrated, but those using native links (i.e. association) may require updates.

; Programs
:Programs and variables will be transferred seamlessly, but some exceptions may occur if ISY Nodes or their commands and/or status have changed.

; Network Resources
: All Network Resources will be migrated seamlessly, however, you will need to open and save each one individually.

; ISY Portal
: See [[ISY_Portal_Migrate_configurations_to_a_new_ISY | ISY Portal Migrate configurations to a new ISY]]

; Polyglot / Node Servers
: See [[Eisy:User_Guide#Migrating_Node_Servers_to_PG3x | Migrating Node Servers to PG3x]]

==Requirements==

# If you are migrating Insteon you must have a compatible PLM
#*Eisy / Polisy supports these PLMs: 2412S, 2413S, 2413U, and 2448A7
#*If you have a 2413S (serial), you will need our [https://www.universal-devices.com/product/serial-plm-kit/ Serial PLM Kit]
# If you are migrating your Z-Wave Network, you must have our [https://www.universal-devices.com/product/zmatter-usb-z-wave-matter-module-for-polisy-beta-copy/ ZMatter Z-Wave USB Dongle]
#*If you are using Polisy, you can alternatively use our [https://www.universal-devices.com/product/zmatter-z-wave-matter-module-for-polisy-beta/ ZMatter Z-Wave Board for Polisy]

== Preparing for Migration from ISY-994 ==

'''On your ISY-994'''

# Make sure the ISY-994 is upgraded to [https://forum.universal-devices.com/topic/33287-release-534-test-build-is-now-available 5.3.4],
# If you are migrating your Z-Wave network
#* You must be using a 500 Series Board in the ISY-994
#* Make a backup of your Z-Wave network (''Admin Console | Z-Wave | Backup'')
#* Make a backup of your ISY-994 (''Admin Console | File | Backup ISY'')
#* Power down your ISY-994 (very important). ISY-994 needs to be powered off because when you migrate, both your ISY-994 and Eisy / Polisy will think they are controlling the Z-Wave network.
# If you are not migrating your Z-Wave network
#* Make a backup of your ISY-994 (''Admin Console | File | Backup ISY'')

== Preparing for Migration from Eisy / Polisy ==

You can migrate locally on the same Eisy / Polisy or to another Eisy / Polisy.

'''On the Eisy / Polisy your are migrating from'''

# Make sure Eisy / Polisy is up to date
#* Go to Admin Console configuration page and select '''update packages'''
# If you are '''not''' migrating your Z-Wave network
#* Use (''Admin Console | File | Backup ISY'') to make a backup of your Eisy / Polisy
# If you are migrating your Z-Wave network
#* Leave your current Z-Wave board / dongle connected
#* Go to configuration tab in Admin Console and select "''Migration ZMatter Z-Wave''"
#* Choose the option that allows you to create a "migration" backup (first option)
#:* You will see a series of popup windows providing information and asking simple questions
#* Once you have your "migration" backup you are ready to migrate
#:* '''A migration backup is different than a regular backup.'''
#:* When a migration backup is restored it also migrates your Z-Wave network

== Migrating ==

'''On the Eisy / Polisy you are migrating to'''

# Do the appropriate preparation step (see above)
# Make sure Eisy / Polisy is up to date
#* Go to Admin Console configuration page and select '''update packages'''
# If you don't have a current backup, make a backup of your Eisy / Polisy (''Admin Console | File | Backup ISY'')
# If you are using Insteon, plug in the PLM
# If you are '''not''' migrating your Z-Wave network
#* Use (''Admin Console | File | Restore ISY'') to restore either your Eisy / Polisy backup or your ISY-994 backup
# If you are migrating your Z-Wave network
#* If you aren't already using it, plug in your ZMatter Z-Wave dongle and unplug any other Z-Wave dongle you may have been using.
#:* ''(Polisy only)'' If you have a ZMatter Z-Wave board then power down Polisy, add it, then power on again.
#:* Reboot Eisy / Polisy
#* Use (''Admin Console | File | Restore ISY'') to restore your "migration" backup
#:* If you are migrating from Eisy / Polisy use the migration backup (e.g. ''"ISY-'''BackupWithZWaveMigration'''.v5.5.4__Sat 2023.01.21 09.07.44 AM"'')
#:* If you are migrating from ISY-994 use your ISY-994 backup
#* When IoX restarts, it automatically does the following:
#:* Writes you Z-Wave network into the ZMatter Z-Wave controller
#:* Interviews every Z-Wave device in the Z-Wave nework, creating/updating nodes, programs and scenes.
#::* This process can take anywhere from a few seconds to a few minutes for each device depending on the complexity of the device.
#::* The best way to monitor the progress is to open the Admin Console Event Viewer to level 3
#::* For those who want lots of low-level details, you can also use this from the command line: ''tail -f /var/isy/FILES/LOG/ZWAY.LOG''
#* If you don't actually change your Z-Wave network by adding/removing Z-Wave devices after migration, you can back out the migration by connecting whatever Z-Wave dongle you were using before migration and restoring the backup you made prior to migration.
# If you are using Insteon
#* Go to the Admin Console configuration tab and make sure [[Eisy:User_Guide#INSTEON_Support | '''INSTEON Support is enabled''']] (default username/pwd = admin/admin)
#* If you are using a new PLM, [[ISY-99i/ISY-26_INSTEON:File_Menu#Restore_Modem_.28PLM.29 | '''Restore the PLM''']]
# Reconfigure any software utilizing to point to this Eisy / Polisy, restart the other software, if necessary.
# If you have ISY Portal on your 994
#* Follow [[ISY_Portal_Migrate_configurations_to_a_new_ISY | '''these instructions''']] to migrate your account, license, and Alexa/Google Home settings
#* This will also migrate all node server licenses from your Polisy to Eisy / Polisy
# If you are using Polyglot / Node Servers
#* See [[Eisy:User_Guide#Migrating_Node_Servers_to_PG3x | '''Migrating Node Servers to PG3x''']]
# If you migrated your Z-Wave Network then make a backup of it (''Z-Wave | Backup'')
# Make a backup of your newly configured IoX.

== Post Migration ==

# If you migrated your Z-Wave Network
#* If you have any Z-Wave nodes with a type of '''''(Placeholder)''''' it means the device has not been migrated yet.
#:* In most cases they are battery powered devices that were not awake during migration
#:* To migrate one of these devices, wake it up (see user manual for the device) and then do the following
#::* right+click on a placeholder node for the device, select ''Z-Wave | Synchronize | Update with Interview''
#:* When it completes do the same for the next device

==Migrating Node Servers to PG3x==
Migration is only possible with version 3.1.17 or later of PG3x. The version of PG3x that ships with eisy is currently 3.1.16 which does not support migration. Please upgrade packages first and make sure you are running version 3.1.17 of PG3x before attempting to migrate.

# Backup PG3 on Polisy.
# Restore from PG3 backup on eisy using the "Migrate from PG3 Backup" option.

Cautions:
* Node servers currently installed on eisy will be removed (and possibly replaced).
* Node servers migrated are left in the "stopped" state. You will need to manually start each one after migration.
* If the Polisy was configured to manage node servers on more than one IoX (say both Polisy IoP and i994) only one IoX will be migrated and you can't choose which one it will migrate.
* Node servers installed on the Polisy from the local node server store will likely fail to install on the eisy.
* Node server licenses should be migrated as part of the Portal migration step.

==UD Mobile==

See https://wiki.universal-devices.com/index.php?title=UD_Mobile#Migration

='''eisy (PG3) Dashboard'''=

You will be prompted with a security warning by your browser because eisy uses a self-signed certificate. Please ignore the warning.

[[File:Notsecure.png]]

You are then presented with the login screen. The default username is '''admin''' and default password is '''admin'''. Please make sure you change your default username/password once you login.

[[File:Login dialog.png]]

Once you have successfully logged into eisy, you will get the eisy Dashboard which is designed to be simple and functional.

==Change Password==

Starting with the eisy the password is managed through the Admin Console user/pass settings. Changing the '''admin''' password in Admin Console (via IoX Launcher) will update PG3x login and will keep the ISY on eisy in sync. It is no longer necessary to change the password in multiple places.

[[File:Eisy-AC-set_admin_user_and_pass1.jpg]] [[File:Eisy-AC-set_admin_user_and_pass2.jpg]]

==ISYs==

The eisy should automatically add the ISY running as '''localhost''' (or at IP 127.0.0.1) on the eisy. You can confirm this by clicking on "ISYs". It should show an ISY UUID with a checkmark next to it. Then click on "Edit Current ISY" to review/confirm information.

You can add/remove ISYs or IoXs through this menu.
# Click on the '''Add New ISY''' menu
# Fill out the entries as shown in the picture below
# Make sure you use HTTP and not HTTPS
[[File:Add_ISY.png]]

==NodeServer Store Menu==

This is where all the available node servers are listed. In order to install one of these node servers into ISY/IoX:
# Click on the name of the Node Server you wish to purchase/install
# Additional information about the Node Server will be displayed, including the purchase/install options available.

[[File:ns_purchase_options.png]]

There are 4 possible purchase options that may be available:
# Trial. Activating a trial license will make the Node Available for the trial period. When selected, the Activate button should change to an Install button.
# Free. Free Node Servers will simply show an Install button and are available to be immediately installed.
# Purchase. Clicking the Purchase button will re-direct you to the Portal purchasing system where you can purchase an license for the Node Server (see steps below).
# Subscription. Click the Purchase button for a subscription will re-direct you to the Portal purchasing system where you can purchase a license for a specific time period.

[[File:ns_purchase_info.png]]

The Purchase Info displays basic info about the node server and which ISY/IoX is currently being manages. Once you've confirmed this is what you wanted, click the Purchase button to re-direct to the Portal purchasing system. You may be asked to log-in to the Portal to complete the following steps.

[[File:ns_purchase.png]]

The Portal purchasing system will give you the option to select the type of license you wish to purchase. Use the drop down box to select the license and then click the button to continue with the payment options.

Once a node server license has been purchased, you will be re-directed back to PG3. Navigate back to the node server store and again select the node server you just purchased. The node server details page will now show an Install button instead of a Purchase button. Clicking the Install button will display the node server installation screen.

[[File:ns_install_details.png]]

If this is the first time installing this node server, you must select an empty slot before installing. If you have previously installed this node server, you will be given the option to re-install it into the slot where it is currently installed.

Once installed, it should show up in the PG3 Dashboard.

==Purchases==
This is where all your node server purchases show up. These node servers are tied to your eisy.

='''Multi Function Button'''=
eisy's power button acts as a multifunction button

==Update and Upgrade All the Packages==
Click the button '''once'''. Please consult [https://www.universal-devices.com/my-tickets/ support] before updating this route. 
Recommended route for updating is through Admin Console -> Configuration Tab -> "Upgrade Packages" button. ‎ 
NOTE: There is not a speaker on the eisy so there will not be any beeps on reboot. 
[[File:Eisy-System-Settings.jpg]]

==Go to WIFI Setup or Leave WIFI Setup mode==
Click the button '''twice'''.

==Reset Credentials==
Click the button '''three times'''
This action resets the following passwords to the default ('''admin/admin'''): 
*SSH
*Polyglot v2
*ISY on eisy(IoX) 
Be sure to change the passwords for these sections after you log-in again.

==Reset Networking==
Click the button '''4 times'''

==Reboot==
Click the button '''5 times'''

==Shutdown==
Click the button '''6 times'''

==Factory Reset==
Click the button '''10 times'''

Please wait 5 minutes after factory reset before attempting to reconnect to system. If System is not found by finder after the 5 minute wait period please reboot system by clicking the button '''5 times''' and waiting one minute for system to come online.

= Using eisy In Desktop Computer Mode =
Yes, you can use eisy as a beautiful desktop running a lean version of XFCE on FreeBSD!

== Attaching HDMI Ports ==
# Click the power button 6 times and wait for eisy to shutdown
# Attach your monitor(s) to the HDMI port(s)
# Click the power button to turn on eisy
# When you see the login prompt, login with your credentials (default = admin/admin)
# Type '''start.win''' at the prompt, accept the licenses, enter your credentials again and voila!

== Installing Development Packages ==
You can do all your node server development on eisy. It has a full set of tools to allow you to compile C/C++, run Python and Node.js, and pretty much anything you can imagine. To install development packages
* sudo udxops.sh install.dev.pkgs
Enjoy!!!

='''Troubleshooting'''=

==Can't Find eisy==
First and foremost, all VPN software block discovery of eisy on your network. As such, if you have a VPN software running, please turn it off.

If you have a modern router, eisy advertises itself as '''eisy.local''' on your network. As such, and in most cases, you should be able to find eisy at <nowiki>https://eisy.local:8443/desc</nowiki>. What you need to do is:
# In IoX Launcher, click on the '''Add''' button
# Enter '''<nowiki>https://eisy.local:8443/desc</nowiki>''' into the dialog
# Click on the '''OK''' button

If you are still having a hard time finding your eisy, it's best to check your router's DHCP client list and look for a device that has the same MAC address as the one the label at the bottom of your eisy. eisy's MAC address starts with '''00:21:b9'''.

Once you find the IP address for eisy, in this '''example''', 192.168.1.122, then
# In IoX Launcher, click on the '''Add''' button
# Enter '''<nowiki>https://192.168.1.122:8443/desc</nowiki>''' into the dialog. '''Note''' 192.168.1.122 is an example. You should use the IP address for your eisy.
# Click on the '''OK''' button

==Can't connect to ZMatter Z-Wave board / dongle==

Some Z-Wave networks with a high amount of constant network traffic can prevent the ISY from detecting the port being used by the ZMatter Z-Wave+ board / dongle.

The port it is using will likely be either '''cuaU0''' or '''cuaU1'''

You can override port detection by doing the following:

# Do this from a browser (if you use ''Help | About'' in Admin Console it will show your IP address e.g. something like ''192.168.0.51'')
#::http://<your_polisy>:8080/rest/zmatter/zwave/port/name/override/set/'''cuaU1'''
# You should get this back (its important you see the 200)
#::<RestResponse succeeded="true"><status>'''200'''</status></RestResponse>
# Restart IoX and it should connect to your ZMatter Z-Wave board / dongle
# If it does not connect, repeat the process but use a different port.

==Upgrade Process - As of July 2022==
Please see [https://forum.universal-devices.com/topic/37257-polisy-update-process-use-admin-console-upgrade-packages-button/ this important update (July 2022)]

Unless explicitly requested by Universal Devices, '''the SSH method of updating the eisy should be avoided'''. Due to recent updates to the underlying operating system, unexpected consequences are being experienced when users force a full package upgrade and update using SSH.

You can simply click on the power button once and eisy will automatically try to upgrade itself. You don't have to reboot.

Or, if you wish to use the Admin Console: e
IoX Launcher to open the ISY Finder window.

Once logged in navigate to:
* Configuration tab
* System

Then click: “Upgrade Packages”

This updating/upgrading process through Admin Console has been developed to handle downloading the proper packages from Universal Devices servers to update UD specific libraries and dependencies needed to keep the eisy operating efficiently and as designed.

Eisy:User Guide

2023-02-01T17:40:43Z

Chris: /* Troubleshooting - Can't connect to ZMatter Z-Wave board / dongle */

Welcome to our eisy corner: your one place for anything eisy!

='''Some Definitions!'''=
==ISY on Anything (IoX)==
IoX is shorthand notation for '''ISY on Anything'''. For the old timers, ISY is the code that runs on the 994, now running as an optimized and fast service on eisy and Polisy.

==Node Servers==
As you might already know, in ISY, everything is represented as a Node. These are things (or devices) that show up in your left navigation bar under ISY. A long time ago, these nodes were limited to INSTEON,X10/A10, Z-Wave, and Zigbee. Basically, protocols for which ISY994 had native support. We designed and developed node servers so that developers could integrate their things into ISY as nodes. And, hence, Node Servers: they serve nodes to ISY.

These nodes can be anything. They represent real devices such as Ring, Tesla, WiFi light bulbs, Ecobee, or they could be virtual such as calendars and climate services. Once a node is represented in ISY, then the whole ISY event based and programming environment are available to it. In short, Node Servers allow ISY to support pretty much any device or thing out there.

But, where do these node servers live? Well, you have come this far, so read on ...

==Polyglot==
Node servers have to run on some computing device. And, forcing each developer to have to come up with his/her own node server from scratch would be completely detrimental to our quest. So, we designed and developed Polyglot which is a framework that allows developers to develop their node servers with ease and confidence that all the plumbing/security and communications with ISY is handled automatically.

'''Polyglot version 3 (PG3)''' is the latest version of Polyglot which includes much enhanced functionality and, most importantly, enables the developers to charge for their node servers. PG3 is only available on eisy and Polisy. Polyglot V2 is not available on eisy.

==eisy | home ==
eisy is our own sbeautiful, powerful hardware/OS preconfigured and optimized to run Polyglot (and other things). So, for those of you non-geeks out there, we have taken all the geekiness out of Polyglot and provided you with a ready to run box. So, now that we got you excited, let's continue with setting up and using your eisy.

='''First Steps'''=

==Installation==
Installation is quite easy
* You can use UD Mobile which walks you through the setup. If not:
* Connect a Cat5e cable to eisy's Network Port and the other to your network. '''Note''': the network must initially be DHCP auto enabled
* Connect the power supply

==Accessing eisy==
IoX Launcher is the best method to find and access all of eisy's features
* Install [[Main_Page#Installing_the_Admin_Console_Icon_on_Your_Desktop | IoX Launcher]]
* Click on the row of the discovered eisy and you will see this menu
[[File:Launcher_Menu.png]]

'''Admin Console (LAN)'''
This menu item downloads the ISY Admin Console directly from eisy

'''Admin Console (Cloud)'''
This menu item downloads the ISY Admin Console from the Universal Devices cloud servers

::Regardless of how you get to the ISY Admin Console (Cloud vs. LAN), the results are the same: Admin Console is brought up and connected directly to your eisy. Admin Console allows you to add/remove/change Z-Wave/INSTEON devices, make programs, and make configuration changes. The best source for what you can do with the Admin Console is our [[Main_Page#ISY_Cookbook | ISY (994) Cookbook]].

'''Polyglot V2 (Deprecated)'''
This is not available on eisy

'''Polyglot V3 (PG3)'''
This takes you to [[eisy:User_Guide#eisy_(PG3)_Dashboard | Polyglot V3 (PG3) Dashboard]].

==Default Username and Password==
'''admin | admin''' is the default username/password for everything in eisy.

To change your password please see the [[Eisy:User_Guide#Change_Password | instructions below]].

==Setup ISY Portal for Remote Access/Alexa/GoogleHome/IFTTT==
* Please use UD Mobile which walks you through the seutp
* If you are migrating from 994, make sure you complete the [[eisy:User_Guide#Migrating_from_994_to_eisy | migration process]] from 994

Don't forget to check out all the things you can do with [[Main_Page#ISY_Portal:_Integration_with_Amazon_Echo.2FGoogle_Home.2FIFTTT | ISY Portal]].

='''Mobile App'''=
[[UD_Mobile | UD Mobile]] is everything you have ever dreamed of. It lets you control and monitor anything that's commissioned to your eisy, and it's FREE! 
UD Mobile is developed by Universal Devices. 
Forum support is available for [https://forum.universal-devices.com/forum/24-ud-mobile/ UD Mobile].

[[File:UDMobile_Featured.jpg]]

='''Device Support'''=

==Z-Wave Support==
# Simply plugin our awesome ZMatter USB dongle
# Go to the Admin Console | Configuration tab
# Check Z-Wave Support Checkbox
# Click the Save button
# Click the Reboot or Restart IoX button.
[[File:Polisy_ZWave.png]]

==Node Servers==
Pick from anything in the [[eisy:User_Guide#NodeServer_Store_Menu | Node Server Store]] and quench your thirst for integration!

==INSTEON Support==
# Connect the PLM to your eisy
eisy supports the following PLMs: 2412S, 2413S, 2413U, and 2448A7. If you have a 2413S (serial), you will need [https://www.universal-devices.com/product/serial-plm-kit/ our Serial PLM Kit]
# Go to the Admin Console | Configuration tab
# Check INSTEON Support Checkbox
# Click the Save button
# Click on the Reboot button. Here's the [[ISY-99i/ISY-26_INSTEON:How-To_Guide | INSTEON User Guide]].
[[File:Polisy_INSTEON.png]]

='''Migration'''=

==Background==
;Insteon
:The Eisy / Polisy implementation of Insteon is a port of the Insteon implementation on the ISY-994. Therefore, you will notice few if any differences.

;Z-Wave
:Our Original Z-Wave implementation is the certified version of Z-Wave on the ISY-994. This code was ported to Eisy / Polisy, but is being deprecated in favor of our new more functional implementation called ''ZMatter Z-Wave''.

:*The original implementation on Eisy / Polisy can use generic Z-Wave controllers such as the Zooz stick, or, it can use the ZMatter Z-Wave controller (either board or USB dongle).

:*The ZMatter Z-Wave implementation can only use the ZMatter Z-Wave controller (either board or USB dongle).

== What to Expect During Migration ==

; Insteon
: The Insteon network on ISY-994 will be seamlessly transferred to Eisy / Polisy. Your nodes, programs, and scenes using Insteon will remain unchanged.

; Z-Wave
: The Z-Wave network managed by ISY-994 will be migrated to the ZMatter Z-Wave implementation on Eisy / Polisy. The devices in the network will remain the same, but their representation in ISY may change.
:* Nodes
:: Z-Wave ISY Nodes will be reused whenever possible, but new nodes may be created as well.
:* Programs
:: Z-Wave ISY nodes in programs will be migrated, however, node actions and conditions may no longer be valid if the node's support for them has changed.
:* Scenes
:: Z-Wave ISY Nodes in scenes will be migrated, but those using native links (i.e. association) may require updates.

; Programs
:Programs and variables will be transferred seamlessly, but some exceptions may occur if ISY Nodes or their commands and/or status have changed.

; Network Resources
: All Network Resources will be migrated seamlessly, however, you will need to open and save each one individually.

; ISY Portal
: See [[ISY_Portal_Migrate_configurations_to_a_new_ISY | ISY Portal Migrate configurations to a new ISY]]

; Polyglot / Node Servers
: See [[Eisy:User_Guide#Migrating_Node_Servers_to_PG3x | Migrating Node Servers to PG3x]]

==Requirements==

# If you are migrating Insteon you must have a compatible PLM
#*Eisy / Polisy supports these PLMs: 2412S, 2413S, 2413U, and 2448A7
#*If you have a 2413S (serial), you will need our [https://www.universal-devices.com/product/serial-plm-kit/ Serial PLM Kit]
# If you are migrating your Z-Wave Network, you must have our [https://www.universal-devices.com/product/zmatter-usb-z-wave-matter-module-for-polisy-beta-copy/ ZMatter Z-Wave USB Dongle]
#*If you are using Polisy, you can alternatively use our [https://www.universal-devices.com/product/zmatter-z-wave-matter-module-for-polisy-beta/ ZMatter Z-Wave Board for Polisy]

== Preparing for Migration from ISY-994 ==

'''On your ISY-994'''

# Make sure the ISY-994 is upgraded to [https://forum.universal-devices.com/topic/33287-release-534-test-build-is-now-available 5.3.4],
# If you are migrating your Z-Wave network
#* You must be using a 500 Series Board in the ISY-994
#* Make a backup of your Z-Wave network (''Admin Console | Z-Wave | Backup'')
#* Make a backup of your ISY-994 (''Admin Console | File | Backup ISY'')
#* Power down your ISY-994 (very important). ISY-994 needs to be powered off because when you migrate, both your ISY-994 and Eisy / Polisy will think they are controlling the Z-Wave network.
# If you are not migrating your Z-Wave network
#* Make a backup of your ISY-994 (''Admin Console | File | Backup ISY'')

== Preparing for Migration from Eisy / Polisy ==

You can migrate locally on the same Eisy / Polisy or to another Eisy / Polisy.

'''On the Eisy / Polisy your are migrating from'''

# Make sure Eisy / Polisy is up to date
#* Go to Admin Console configuration page and select '''update packages'''
# If you are '''not''' migrating your Z-Wave network
#* Use (''Admin Console | File | Backup ISY'') to make a backup of your Eisy / Polisy
# If you are migrating your Z-Wave network
#* Leave your current Z-Wave board / dongle connected
#* Go to configuration tab in Admin Console and select "''Migration ZMatter Z-Wave''"
#* Choose the option that allows you to create a "migration" backup (first option)
#:* You will see a series of popup windows providing information and asking simple questions
#* Once you have your "migration" backup you are ready to migrate
#:* '''A migration backup is different than a regular backup.'''
#:* When a migration backup is restored it also migrates your Z-Wave network

== Migrating ==

'''On the Eisy / Polisy you are migrating to'''

# Do the appropriate preparation step (see above)
# Make sure Eisy / Polisy is up to date
#* Go to Admin Console configuration page and select '''update packages'''
# If you don't have a current backup, make a backup of your Eisy / Polisy (''Admin Console | File | Backup ISY'')
# If you are using Insteon, plug in the PLM
# If you are '''not''' migrating your Z-Wave network
#* Use (''Admin Console | File | Restore ISY'') to restore either your Eisy / Polisy backup or your ISY-994 backup
# If you are migrating your Z-Wave network
#* If you aren't already using it, plug in your ZMatter Z-Wave dongle and unplug any other Z-Wave dongle you may have been using.
#:* ''(Polisy only)'' If you have a ZMatter Z-Wave board then power down Polisy, add it, then power on again.
#* Use (''Admin Console | File | Restore ISY'') to restore your "migration" backup
#:* If you are migrating from Eisy / Polisy use the migration backup (e.g. ''"ISY-'''BackupWithZWaveMigration'''.v5.5.4__Sat 2023.01.21 09.07.44 AM"'')
#:* If you are migrating from ISY-994 use your ISY-994 backup
#* When Eisy / Polisy restarts, it automatically does the following:
#:* Writes you Z-Wave network into the ZMatter Z-Wave controller
#:* Interviews every Z-Wave device in the Z-Wave nework, creating/updating nodes, programs and scenes.
#::* This process can take anywhere from a few seconds to a few minutes for each device depending on the complexity of the device.
#::* The best way to monitor the progress is to open the Admin Console Event Viewer to level 3
#::* For those who want lots of low-level details, you can also use this from the command line: ''tail -f /var/isy/FILES/LOG/ZWAY.LOG''
#* If you don't actually change your Z-Wave network by adding/removing Z-Wave devices after migration, you can back out the migration by connecting whatever Z-Wave dongle you were using before migration and restoring the backup you made prior to migration.
# If you are using Insteon
#* Go to the Admin Console configuration tab and make sure [[Eisy:User_Guide#INSTEON_Support | '''INSTEON Support is enabled''']] (default username/pwd = admin/admin)
#* If you are using a new PLM, [[ISY-99i/ISY-26_INSTEON:File_Menu#Restore_Modem_.28PLM.29 | '''Restore the PLM''']]
# Reconfigure any software utilizing to point to this Eisy / Polisy, restart the other software, if necessary.
# If you have ISY Portal on your 994
#* Follow [[ISY_Portal_Migrate_configurations_to_a_new_ISY | '''these instructions''']] to migrate your account, license, and Alexa/Google Home settings
#* This will also migrate all node server licenses from your Polisy to Eisy / Polisy
# If you are using Polyglot / Node Servers
#* See [[Eisy:User_Guide#Migrating_Node_Servers_to_PG3x | '''Migrating Node Servers to PG3x''']]
# If you migrated your Z-Wave Network then make a backup of it (''Z-Wave | Backup'')
# Make a backup of your newly configured IoX.

== Post Migration ==

# If you migrated your Z-Wave Network
#* If you have any Z-Wave nodes with a type of '''''(Placeholder)''''' it means the device has not been migrated yet.
#:* In most cases they are battery powered devices that were not awake during migration
#:* To migrate one of these devices, wake it up (see user manual for the device) and then do the following
#::* right+click on a placeholder node for the device, select ''Z-Wave | Synchronize | Update with Interview''
#:* When it completes do the same for the next device

==Migrating Node Servers to PG3x==
Migration is only possible with version 3.1.17 or later of PG3x. The version of PG3x that ships with eisy is currently 3.1.16 which does not support migration. Please upgrade packages first and make sure you are running version 3.1.17 of PG3x before attempting to migrate.

# Backup PG3 on Polisy.
# Restore from PG3 backup on eisy using the "Migrate from PG3 Backup" option.

Cautions:
* Node servers currently installed on eisy will be removed (and possibly replaced).
* Node servers migrated are left in the "stopped" state. You will need to manually start each one after migration.
* If the Polisy was configured to manage node servers on more than one IoX (say both Polisy IoP and i994) only one IoX will be migrated and you can't choose which one it will migrate.
* Node servers installed on the Polisy from the local node server store will likely fail to install on the eisy.
* Node server licenses should be migrated as part of the Portal migration step.

==UD Mobile==

See https://wiki.universal-devices.com/index.php?title=UD_Mobile#Migration

='''eisy (PG3) Dashboard'''=

You will be prompted with a security warning by your browser because eisy uses a self-signed certificate. Please ignore the warning.

[[File:Notsecure.png]]

You are then presented with the login screen. The default username is '''admin''' and default password is '''admin'''. Please make sure you change your default username/password once you login.

[[File:Login dialog.png]]

Once you have successfully logged into eisy, you will get the eisy Dashboard which is designed to be simple and functional.

==Change Password==

Starting with the eisy the password is managed through the Admin Console user/pass settings. Changing the '''admin''' password in Admin Console (via IoX Launcher) will update PG3x login and will keep the ISY on eisy in sync. It is no longer necessary to change the password in multiple places.

[[File:Eisy-AC-set_admin_user_and_pass1.jpg]] [[File:Eisy-AC-set_admin_user_and_pass2.jpg]]

==ISYs==

The eisy should automatically add the ISY running as '''localhost''' (or at IP 127.0.0.1) on the eisy. You can confirm this by clicking on "ISYs". It should show an ISY UUID with a checkmark next to it. Then click on "Edit Current ISY" to review/confirm information.

You can add/remove ISYs or IoXs through this menu.
# Click on the '''Add New ISY''' menu
# Fill out the entries as shown in the picture below
# Make sure you use HTTP and not HTTPS
[[File:Add_ISY.png]]

==NodeServer Store Menu==

This is where all the available node servers are listed. In order to install one of these node servers into ISY/IoX:
# Click on the name of the Node Server you wish to purchase/install
# Additional information about the Node Server will be displayed, including the purchase/install options available.

[[File:ns_purchase_options.png]]

There are 4 possible purchase options that may be available:
# Trial. Activating a trial license will make the Node Available for the trial period. When selected, the Activate button should change to an Install button.
# Free. Free Node Servers will simply show an Install button and are available to be immediately installed.
# Purchase. Clicking the Purchase button will re-direct you to the Portal purchasing system where you can purchase an license for the Node Server (see steps below).
# Subscription. Click the Purchase button for a subscription will re-direct you to the Portal purchasing system where you can purchase a license for a specific time period.

[[File:ns_purchase_info.png]]

The Purchase Info displays basic info about the node server and which ISY/IoX is currently being manages. Once you've confirmed this is what you wanted, click the Purchase button to re-direct to the Portal purchasing system. You may be asked to log-in to the Portal to complete the following steps.

[[File:ns_purchase.png]]

The Portal purchasing system will give you the option to select the type of license you wish to purchase. Use the drop down box to select the license and then click the button to continue with the payment options.

Once a node server license has been purchased, you will be re-directed back to PG3. Navigate back to the node server store and again select the node server you just purchased. The node server details page will now show an Install button instead of a Purchase button. Clicking the Install button will display the node server installation screen.

[[File:ns_install_details.png]]

If this is the first time installing this node server, you must select an empty slot before installing. If you have previously installed this node server, you will be given the option to re-install it into the slot where it is currently installed.

Once installed, it should show up in the PG3 Dashboard.

==Purchases==
This is where all your node server purchases show up. These node servers are tied to your eisy.

='''Multi Function Button'''=
eisy's power button acts as a multifunction button

==Update and Upgrade All the Packages==
Click the button '''once'''. Please consult [https://www.universal-devices.com/my-tickets/ support] before updating this route. 
Recommended route for updating is through Admin Console -> Configuration Tab -> "Upgrade Packages" button. ‎ 
NOTE: There is not a speaker on the eisy so there will not be any beeps on reboot. 
[[File:Eisy-System-Settings.jpg]]

==Go to WIFI Setup or Leave WIFI Setup mode==
Click the button '''twice'''.

==Reset Credentials==
Click the button '''three times'''
This action resets the following passwords to the default ('''admin/admin'''): 
*SSH
*Polyglot v2
*ISY on eisy(IoX) 
Be sure to change the passwords for these sections after you log-in again.

==Reset Networking==
Click the button '''4 times'''

==Reboot==
Click the button '''5 times'''

==Shutdown==
Click the button '''6 times'''

==Factory Reset==
Click the button '''10 times'''

Please wait 5 minutes after factory reset before attempting to reconnect to system. If System is not found by finder after the 5 minute wait period please reboot system by clicking the button '''5 times''' and waiting one minute for system to come online.

= Using eisy In Desktop Computer Mode =
Yes, you can use eisy as a beautiful desktop running a lean version of XFCE on FreeBSD!

== Attaching HDMI Ports ==
# Click the power button 6 times and wait for eisy to shutdown
# Attach your monitor(s) to the HDMI port(s)
# Click the power button to turn on eisy
# When you see the login prompt, login with your credentials (default = admin/admin)
# Type '''start.win''' at the prompt, accept the licenses, enter your credentials again and voila!

== Installing Development Packages ==
You can do all your node server development on eisy. It has a full set of tools to allow you to compile C/C++, run Python and Node.js, and pretty much anything you can imagine. To install development packages
* sudo udxops.sh install.dev.pkgs
Enjoy!!!

='''Troubleshooting'''=

==Can't Find eisy==
First and foremost, all VPN software block discovery of eisy on your network. As such, if you have a VPN software running, please turn it off.

If you have a modern router, eisy advertises itself as '''eisy.local''' on your network. As such, and in most cases, you should be able to find eisy at <nowiki>https://eisy.local:8443/desc</nowiki>. What you need to do is:
# In IoX Launcher, click on the '''Add''' button
# Enter '''<nowiki>https://eisy.local:8443/desc</nowiki>''' into the dialog
# Click on the '''OK''' button

If you are still having a hard time finding your eisy, it's best to check your router's DHCP client list and look for a device that has the same MAC address as the one the label at the bottom of your eisy. eisy's MAC address starts with '''00:21:b9'''.

Once you find the IP address for eisy, in this '''example''', 192.168.1.122, then
# In IoX Launcher, click on the '''Add''' button
# Enter '''<nowiki>https://192.168.1.122:8443/desc</nowiki>''' into the dialog. '''Note''' 192.168.1.122 is an example. You should use the IP address for your eisy.
# Click on the '''OK''' button

==Can't connect to ZMatter Z-Wave board / dongle==

Some Z-Wave networks with a high amount of constant network traffic can prevent the ISY from detecting the port being used by the ZMatter Z-Wave+ board / dongle.

The port it is using will likely be either '''cuaU0''' or '''cuaU1'''

You can override port detection by doing the following:

# Do this from a browser (if you use ''Help | About'' in Admin Console it will show your IP address e.g. something like ''192.168.0.51'')
#::http://<your_polisy>:8080/rest/zmatter/zwave/port/name/override/set/'''cuaU1'''
# You should get this back (its important you see the 200)
#::<RestResponse succeeded="true"><status>'''200'''</status></RestResponse>
# Restart IoX and it should connect to your ZMatter Z-Wave board / dongle
# If it does not connect, repeat the process but use a different port.

==Upgrade Process - As of July 2022==
Please see [https://forum.universal-devices.com/topic/37257-polisy-update-process-use-admin-console-upgrade-packages-button/ this important update (July 2022)]

Unless explicitly requested by Universal Devices, '''the SSH method of updating the eisy should be avoided'''. Due to recent updates to the underlying operating system, unexpected consequences are being experienced when users force a full package upgrade and update using SSH.

You can simply click on the power button once and eisy will automatically try to upgrade itself. You don't have to reboot.

Or, if you wish to use the Admin Console: e
IoX Launcher to open the ISY Finder window.

Once logged in navigate to:
* Configuration tab
* System

Then click: “Upgrade Packages”

This updating/upgrading process through Admin Console has been developed to handle downloading the proper packages from Universal Devices servers to update UD specific libraries and dependencies needed to keep the eisy operating efficiently and as designed.

Eisy:User Guide

2023-02-01T15:59:26Z

Chris: /* Migrating */

Welcome to our eisy corner: your one place for anything eisy!

='''Some Definitions!'''=
==ISY on Anything (IoX)==
IoX is shorthand notation for '''ISY on Anything'''. For the old timers, ISY is the code that runs on the 994, now running as an optimized and fast service on eisy and Polisy.

==Node Servers==
As you might already know, in ISY, everything is represented as a Node. These are things (or devices) that show up in your left navigation bar under ISY. A long time ago, these nodes were limited to INSTEON,X10/A10, Z-Wave, and Zigbee. Basically, protocols for which ISY994 had native support. We designed and developed node servers so that developers could integrate their things into ISY as nodes. And, hence, Node Servers: they serve nodes to ISY.

These nodes can be anything. They represent real devices such as Ring, Tesla, WiFi light bulbs, Ecobee, or they could be virtual such as calendars and climate services. Once a node is represented in ISY, then the whole ISY event based and programming environment are available to it. In short, Node Servers allow ISY to support pretty much any device or thing out there.

But, where do these node servers live? Well, you have come this far, so read on ...

==Polyglot==
Node servers have to run on some computing device. And, forcing each developer to have to come up with his/her own node server from scratch would be completely detrimental to our quest. So, we designed and developed Polyglot which is a framework that allows developers to develop their node servers with ease and confidence that all the plumbing/security and communications with ISY is handled automatically.

'''Polyglot version 3 (PG3)''' is the latest version of Polyglot which includes much enhanced functionality and, most importantly, enables the developers to charge for their node servers. PG3 is only available on eisy and Polisy. Polyglot V2 is not available on eisy.

==eisy | home ==
eisy is our own sbeautiful, powerful hardware/OS preconfigured and optimized to run Polyglot (and other things). So, for those of you non-geeks out there, we have taken all the geekiness out of Polyglot and provided you with a ready to run box. So, now that we got you excited, let's continue with setting up and using your eisy.

='''First Steps'''=

==Installation==
Installation is quite easy
* You can use UD Mobile which walks you through the setup. If not:
* Connect a Cat5e cable to eisy's Network Port and the other to your network. '''Note''': the network must initially be DHCP auto enabled
* Connect the power supply

==Accessing eisy==
IoX Launcher is the best method to find and access all of eisy's features
* Install [[Main_Page#Installing_the_Admin_Console_Icon_on_Your_Desktop | IoX Launcher]]
* Click on the row of the discovered eisy and you will see this menu
[[File:Launcher_Menu.png]]

'''Admin Console (LAN)'''
This menu item downloads the ISY Admin Console directly from eisy

'''Admin Console (Cloud)'''
This menu item downloads the ISY Admin Console from the Universal Devices cloud servers

::Regardless of how you get to the ISY Admin Console (Cloud vs. LAN), the results are the same: Admin Console is brought up and connected directly to your eisy. Admin Console allows you to add/remove/change Z-Wave/INSTEON devices, make programs, and make configuration changes. The best source for what you can do with the Admin Console is our [[Main_Page#ISY_Cookbook | ISY (994) Cookbook]].

'''Polyglot V2 (Deprecated)'''
This is not available on eisy

'''Polyglot V3 (PG3)'''
This takes you to [[eisy:User_Guide#eisy_(PG3)_Dashboard | Polyglot V3 (PG3) Dashboard]].

==Default Username and Password==
'''admin | admin''' is the default username/password for everything in eisy.

To change your password please see the [[Eisy:User_Guide#Change_Password | instructions below]].

==Setup ISY Portal for Remote Access/Alexa/GoogleHome/IFTTT==
* Please use UD Mobile which walks you through the seutp
* If you are migrating from 994, make sure you complete the [[eisy:User_Guide#Migrating_from_994_to_eisy | migration process]] from 994

Don't forget to check out all the things you can do with [[Main_Page#ISY_Portal:_Integration_with_Amazon_Echo.2FGoogle_Home.2FIFTTT | ISY Portal]].

='''Mobile App'''=
[[UD_Mobile | UD Mobile]] is everything you have ever dreamed of. It lets you control and monitor anything that's commissioned to your eisy, and it's FREE! 
UD Mobile is developed by Universal Devices. 
Forum support is available for [https://forum.universal-devices.com/forum/24-ud-mobile/ UD Mobile].

[[File:UDMobile_Featured.jpg]]

='''Device Support'''=

==Z-Wave Support==
# Simply plugin our awesome ZMatter USB dongle
# Go to the Admin Console | Configuration tab
# Check Z-Wave Support Checkbox
# Click the Save button
# Click the Reboot or Restart IoX button.
[[File:Polisy_ZWave.png]]

==Node Servers==
Pick from anything in the [[eisy:User_Guide#NodeServer_Store_Menu | Node Server Store]] and quench your thirst for integration!

==INSTEON Support==
# Connect the PLM to your eisy
eisy supports the following PLMs: 2412S, 2413S, 2413U, and 2448A7. If you have a 2413S (serial), you will need [https://www.universal-devices.com/product/serial-plm-kit/ our Serial PLM Kit]
# Go to the Admin Console | Configuration tab
# Check INSTEON Support Checkbox
# Click the Save button
# Click on the Reboot button. Here's the [[ISY-99i/ISY-26_INSTEON:How-To_Guide | INSTEON User Guide]].
[[File:Polisy_INSTEON.png]]

='''Migration'''=

==Background==
;Insteon
:The Eisy / Polisy implementation of Insteon is a port of the Insteon implementation on the ISY-994. Therefore, you will notice few if any differences.

;Z-Wave
:Our Original Z-Wave implementation is the certified version of Z-Wave on the ISY-994. This code was ported to Eisy / Polisy, but is being deprecated in favor of our new more functional implementation called ''ZMatter Z-Wave''.

:*The original implementation on Eisy / Polisy can use generic Z-Wave controllers such as the Zooz stick, or, it can use the ZMatter Z-Wave controller (either board or USB dongle).

:*The ZMatter Z-Wave implementation can only use the ZMatter Z-Wave controller (either board or USB dongle).

== What to Expect During Migration ==

; Insteon
: The Insteon network on ISY-994 will be seamlessly transferred to Eisy / Polisy. Your nodes, programs, and scenes using Insteon will remain unchanged.

; Z-Wave
: The Z-Wave network managed by ISY-994 will be migrated to the ZMatter Z-Wave implementation on Eisy / Polisy. The devices in the network will remain the same, but their representation in ISY may change.
:* Nodes
:: Z-Wave ISY Nodes will be reused whenever possible, but new nodes may be created as well.
:* Programs
:: Z-Wave ISY nodes in programs will be migrated, however, node actions and conditions may no longer be valid if the node's support for them has changed.
:* Scenes
:: Z-Wave ISY Nodes in scenes will be migrated, but those using native links (i.e. association) may require updates.

; Programs
:Programs and variables will be transferred seamlessly, but some exceptions may occur if ISY Nodes or their commands and/or status have changed.

; Network Resources
: All Network Resources will be migrated seamlessly, however, you will need to open and save each one individually.

; ISY Portal
: See [[ISY_Portal_Migrate_configurations_to_a_new_ISY | ISY Portal Migrate configurations to a new ISY]]

; Polyglot / Node Servers
: See [[Eisy:User_Guide#Migrating_Node_Servers_to_PG3x | Migrating Node Servers to PG3x]]

==Requirements==

# If you are migrating Insteon you must have a compatible PLM
#*Eisy / Polisy supports these PLMs: 2412S, 2413S, 2413U, and 2448A7
#*If you have a 2413S (serial), you will need our [https://www.universal-devices.com/product/serial-plm-kit/ Serial PLM Kit]
# If you are migrating your Z-Wave Network, you must have our [https://www.universal-devices.com/product/zmatter-usb-z-wave-matter-module-for-polisy-beta-copy/ ZMatter Z-Wave USB Dongle]
#*If you are using Polisy, you can alternatively use our [https://www.universal-devices.com/product/zmatter-z-wave-matter-module-for-polisy-beta/ ZMatter Z-Wave Board for Polisy]

== Preparing for Migration from ISY-994 ==

'''On your ISY-994'''

# Make sure the ISY-994 is upgraded to [https://forum.universal-devices.com/topic/33287-release-534-test-build-is-now-available 5.3.4],
# If you are migrating your Z-Wave network
#* You must be using a 500 Series Board in the ISY-994
#* Make a backup of your Z-Wave network (''Admin Console | Z-Wave | Backup'')
#* Make a backup of your ISY-994 (''Admin Console | File | Backup ISY'')
#* Power down your ISY-994 (very important). ISY-994 needs to be powered off because when you migrate, both your ISY-994 and Eisy / Polisy will think they are controlling the Z-Wave network.
# If you are not migrating your Z-Wave network
#* Make a backup of your ISY-994 (''Admin Console | File | Backup ISY'')

== Preparing for Migration from Eisy / Polisy ==

You can migrate locally on the same Eisy / Polisy or to another Eisy / Polisy.

'''On the Eisy / Polisy your are migrating from'''

# Make sure Eisy / Polisy is up to date
#* Go to Admin Console configuration page and select '''update packages'''
# If you are '''not''' migrating your Z-Wave network
#* Use (''Admin Console | File | Backup ISY'') to make a backup of your Eisy / Polisy
# If you are migrating your Z-Wave network
#* Leave your current Z-Wave board / dongle connected
#* Go to configuration tab in Admin Console and select "''Migration ZMatter Z-Wave''"
#* Choose the option that allows you to create a "migration" backup (first option)
#:* You will see a series of popup windows providing information and asking simple questions
#* Once you have your "migration" backup you are ready to migrate
#:* '''A migration backup is different than a regular backup.'''
#:* When a migration backup is restored it also migrates your Z-Wave network

== Migrating ==

'''On the Eisy / Polisy you are migrating to'''

# Do the appropriate preparation step (see above)
# Make sure Eisy / Polisy is up to date
#* Go to Admin Console configuration page and select '''update packages'''
# If you don't have a current backup, make a backup of your Eisy / Polisy (''Admin Console | File | Backup ISY'')
# If you are using Insteon, plug in the PLM
# If you are '''not''' migrating your Z-Wave network
#* Use (''Admin Console | File | Restore ISY'') to restore either your Eisy / Polisy backup or your ISY-994 backup
# If you are migrating your Z-Wave network
#* If you aren't already using it, plug in your ZMatter Z-Wave dongle and unplug any other Z-Wave dongle you may have been using.
#:* ''(Polisy only)'' If you have a ZMatter Z-Wave board then power down Polisy, add it, then power on again.
#* Use (''Admin Console | File | Restore ISY'') to restore your "migration" backup
#:* If you are migrating from Eisy / Polisy use the migration backup (e.g. ''"ISY-'''BackupWithZWaveMigration'''.v5.5.4__Sat 2023.01.21 09.07.44 AM"'')
#:* If you are migrating from ISY-994 use your ISY-994 backup
#* When Eisy / Polisy restarts, it automatically does the following:
#:* Writes you Z-Wave network into the ZMatter Z-Wave controller
#:* Interviews every Z-Wave device in the Z-Wave nework, creating/updating nodes, programs and scenes.
#::* This process can take anywhere from a few seconds to a few minutes for each device depending on the complexity of the device.
#::* The best way to monitor the progress is to open the Admin Console Event Viewer to level 3
#::* For those who want lots of low-level details, you can also use this from the command line: ''tail -f /var/isy/FILES/LOG/ZWAY.LOG''
#* If you don't actually change your Z-Wave network by adding/removing Z-Wave devices after migration, you can back out the migration by connecting whatever Z-Wave dongle you were using before migration and restoring the backup you made prior to migration.
# If you are using Insteon
#* Go to the Admin Console configuration tab and make sure [[Eisy:User_Guide#INSTEON_Support | '''INSTEON Support is enabled''']] (default username/pwd = admin/admin)
#* If you are using a new PLM, [[ISY-99i/ISY-26_INSTEON:File_Menu#Restore_Modem_.28PLM.29 | '''Restore the PLM''']]
# Reconfigure any software utilizing to point to this Eisy / Polisy, restart the other software, if necessary.
# If you have ISY Portal on your 994
#* Follow [[ISY_Portal_Migrate_configurations_to_a_new_ISY | '''these instructions''']] to migrate your account, license, and Alexa/Google Home settings
#* This will also migrate all node server licenses from your Polisy to Eisy / Polisy
# If you are using Polyglot / Node Servers
#* See [[Eisy:User_Guide#Migrating_Node_Servers_to_PG3x | '''Migrating Node Servers to PG3x''']]
# If you migrated your Z-Wave Network then make a backup of it (''Z-Wave | Backup'')
# Make a backup of your newly configured IoX.

== Post Migration ==

# If you migrated your Z-Wave Network
#* If you have any Z-Wave nodes with a type of '''''(Placeholder)''''' it means the device has not been migrated yet.
#:* In most cases they are battery powered devices that were not awake during migration
#:* To migrate one of these devices, wake it up (see user manual for the device) and then do the following
#::* right+click on a placeholder node for the device, select ''Z-Wave | Synchronize | Update with Interview''
#:* When it completes do the same for the next device

==Migrating Node Servers to PG3x==
Migration is only possible with version 3.1.17 or later of PG3x. The version of PG3x that ships with eisy is currently 3.1.16 which does not support migration. Please upgrade packages first and make sure you are running version 3.1.17 of PG3x before attempting to migrate.

# Backup PG3 on Polisy.
# Restore from PG3 backup on eisy using the "Migrate from PG3 Backup" option.

Cautions:
* Node servers currently installed on eisy will be removed (and possibly replaced).
* Node servers migrated are left in the "stopped" state. You will need to manually start each one after migration.
* If the Polisy was configured to manage node servers on more than one IoX (say both Polisy IoP and i994) only one IoX will be migrated and you can't choose which one it will migrate.
* Node servers installed on the Polisy from the local node server store will likely fail to install on the eisy.
* Node server licenses should be migrated as part of the Portal migration step.

==UD Mobile==

See https://wiki.universal-devices.com/index.php?title=UD_Mobile#Migration

='''eisy (PG3) Dashboard'''=

You will be prompted with a security warning by your browser because eisy uses a self-signed certificate. Please ignore the warning.

[[File:Notsecure.png]]

You are then presented with the login screen. The default username is '''admin''' and default password is '''admin'''. Please make sure you change your default username/password once you login.

[[File:Login dialog.png]]

Once you have successfully logged into eisy, you will get the eisy Dashboard which is designed to be simple and functional.

==Change Password==

Starting with the eisy the password is managed through the Admin Console user/pass settings. Changing the '''admin''' password in Admin Console (via IoX Launcher) will update PG3x login and will keep the ISY on eisy in sync. It is no longer necessary to change the password in multiple places.

[[File:Eisy-AC-set_admin_user_and_pass1.jpg]] [[File:Eisy-AC-set_admin_user_and_pass2.jpg]]

==ISYs==

The eisy should automatically add the ISY running as '''localhost''' (or at IP 127.0.0.1) on the eisy. You can confirm this by clicking on "ISYs". It should show an ISY UUID with a checkmark next to it. Then click on "Edit Current ISY" to review/confirm information.

You can add/remove ISYs or IoXs through this menu.
# Click on the '''Add New ISY''' menu
# Fill out the entries as shown in the picture below
# Make sure you use HTTP and not HTTPS
[[File:Add_ISY.png]]

==NodeServer Store Menu==

This is where all the available node servers are listed. In order to install one of these node servers into ISY/IoX:
# Click on the name of the Node Server you wish to purchase/install
# Additional information about the Node Server will be displayed, including the purchase/install options available.

[[File:ns_purchase_options.png]]

There are 4 possible purchase options that may be available:
# Trial. Activating a trial license will make the Node Available for the trial period. When selected, the Activate button should change to an Install button.
# Free. Free Node Servers will simply show an Install button and are available to be immediately installed.
# Purchase. Clicking the Purchase button will re-direct you to the Portal purchasing system where you can purchase an license for the Node Server (see steps below).
# Subscription. Click the Purchase button for a subscription will re-direct you to the Portal purchasing system where you can purchase a license for a specific time period.

[[File:ns_purchase_info.png]]

The Purchase Info displays basic info about the node server and which ISY/IoX is currently being manages. Once you've confirmed this is what you wanted, click the Purchase button to re-direct to the Portal purchasing system. You may be asked to log-in to the Portal to complete the following steps.

[[File:ns_purchase.png]]

The Portal purchasing system will give you the option to select the type of license you wish to purchase. Use the drop down box to select the license and then click the button to continue with the payment options.

Once a node server license has been purchased, you will be re-directed back to PG3. Navigate back to the node server store and again select the node server you just purchased. The node server details page will now show an Install button instead of a Purchase button. Clicking the Install button will display the node server installation screen.

[[File:ns_install_details.png]]

If this is the first time installing this node server, you must select an empty slot before installing. If you have previously installed this node server, you will be given the option to re-install it into the slot where it is currently installed.

Once installed, it should show up in the PG3 Dashboard.

==Purchases==
This is where all your node server purchases show up. These node servers are tied to your eisy.

='''Multi Function Button'''=
eisy's power button acts as a multifunction button

==Update and Upgrade All the Packages==
Click the button '''once'''. Please consult [https://www.universal-devices.com/my-tickets/ support] before updating this route. 
Recommended route for updating is through Admin Console -> Configuration Tab -> "Upgrade Packages" button. ‎ 
NOTE: There is not a speaker on the eisy so there will not be any beeps on reboot. 
[[File:Eisy-System-Settings.jpg]]

==Go to WIFI Setup or Leave WIFI Setup mode==
Click the button '''twice'''.

==Reset Credentials==
Click the button '''three times'''
This action resets the following passwords to the default ('''admin/admin'''): 
*SSH
*Polyglot v2
*ISY on eisy(IoX) 
Be sure to change the passwords for these sections after you log-in again.

==Reset Networking==
Click the button '''4 times'''

==Reboot==
Click the button '''5 times'''

==Shutdown==
Click the button '''6 times'''

==Factory Reset==
Click the button '''10 times'''

Please wait 5 minutes after factory reset before attempting to reconnect to system. If System is not found by finder after the 5 minute wait period please reboot system by clicking the button '''5 times''' and waiting one minute for system to come online.

= Using eisy In Desktop Computer Mode =
Yes, you can use eisy as a beautiful desktop running a lean version of XFCE on FreeBSD!

== Attaching HDMI Ports ==
# Click the power button 6 times and wait for eisy to shutdown
# Attach your monitor(s) to the HDMI port(s)
# Click the power button to turn on eisy
# When you see the login prompt, login with your credentials (default = admin/admin)
# Type '''start.win''' at the prompt, accept the licenses, enter your credentials again and voila!

== Installing Development Packages ==
You can do all your node server development on eisy. It has a full set of tools to allow you to compile C/C++, run Python and Node.js, and pretty much anything you can imagine. To install development packages
* sudo udxops.sh install.dev.pkgs
Enjoy!!!

='''Troubleshooting'''=

==Can't Find eisy==
First and foremost, all VPN software block discovery of eisy on your network. As such, if you have a VPN software running, please turn it off.

If you have a modern router, eisy advertises itself as '''eisy.local''' on your network. As such, and in most cases, you should be able to find eisy at <nowiki>https://eisy.local:8443/desc</nowiki>. What you need to do is:
# In IoX Launcher, click on the '''Add''' button
# Enter '''<nowiki>https://eisy.local:8443/desc</nowiki>''' into the dialog
# Click on the '''OK''' button

If you are still having a hard time finding your eisy, it's best to check your router's DHCP client list and look for a device that has the same MAC address as the one the label at the bottom of your eisy. eisy's MAC address starts with '''00:21:b9'''.

Once you find the IP address for eisy, in this '''example''', 192.168.1.122, then
# In IoX Launcher, click on the '''Add''' button
# Enter '''<nowiki>https://192.168.1.122:8443/desc</nowiki>''' into the dialog. '''Note''' 192.168.1.122 is an example. You should use the IP address for your eisy.
# Click on the '''OK''' button

==Upgrade Process - As of July 2022==
Please see [https://forum.universal-devices.com/topic/37257-polisy-update-process-use-admin-console-upgrade-packages-button/ this important update (July 2022)]

Unless explicitly requested by Universal Devices, '''the SSH method of updating the eisy should be avoided'''. Due to recent updates to the underlying operating system, unexpected consequences are being experienced when users force a full package upgrade and update using SSH.

You can simply click on the power button once and eisy will automatically try to upgrade itself. You don't have to reboot.

Or, if you wish to use the Admin Console: e
IoX Launcher to open the ISY Finder window.

Once logged in navigate to:
* Configuration tab
* System

Then click: “Upgrade Packages”

This updating/upgrading process through Admin Console has been developed to handle downloading the proper packages from Universal Devices servers to update UD specific libraries and dependencies needed to keep the eisy operating efficiently and as designed.

Eisy:User Guide

2023-01-24T22:02:23Z

Chris: /* Migrating */

Welcome to our eisy corner: your one place for anything eisy!

='''Some Definitions!'''=
==ISY on Anything (IoX)==
IoX is shorthand notation for '''ISY on Anything'''. For the old timers, ISY is the code that runs on the 994, now running as an optimized and fast service on eisy and Polisy.

==Node Servers==
As you might already know, in ISY, everything is represented as a Node. These are things (or devices) that show up in your left navigation bar under ISY. A long time ago, these nodes were limited to INSTEON,X10/A10, Z-Wave, and Zigbee. Basically, protocols for which ISY994 had native support. We designed and developed node servers so that developers could integrate their things into ISY as nodes. And, hence, Node Servers: they serve nodes to ISY.

These nodes can be anything. They represent real devices such as Ring, Tesla, WiFi light bulbs, Ecobee, or they could be virtual such as calendars and climate services. Once a node is represented in ISY, then the whole ISY event based and programming environment are available to it. In short, Node Servers allow ISY to support pretty much any device or thing out there.

But, where do these node servers live? Well, you have come this far, so read on ...

==Polyglot==
Node servers have to run on some computing device. And, forcing each developer to have to come up with his/her own node server from scratch would be completely detrimental to our quest. So, we designed and developed Polyglot which is a framework that allows developers to develop their node servers with ease and confidence that all the plumbing/security and communications with ISY is handled automatically.

'''Polyglot version 3 (PG3)''' is the latest version of Polyglot which includes much enhanced functionality and, most importantly, enables the developers to charge for their node servers. PG3 is only available on eisy and Polisy. Polyglot V2 is not available on eisy.

==eisy | home ==
eisy is our own sbeautiful, powerful hardware/OS preconfigured and optimized to run Polyglot (and other things). So, for those of you non-geeks out there, we have taken all the geekiness out of Polyglot and provided you with a ready to run box. So, now that we got you excited, let's continue with setting up and using your eisy.

='''First Steps'''=

==Installation==
Installation is quite easy
* You can use UD Mobile which walks you through the setup. If not:
* Connect a Cat5e cable to eisy's Network Port and the other to your network. '''Note''': the network must initially be DHCP auto enabled
* Connect the power supply

==Accessing eisy==
IoX Launcher is the best method to find and access all of eisy's features
* Install [[Main_Page#Installing_the_Admin_Console_Icon_on_Your_Desktop | IoX Launcher]]
* Click on the row of the discovered eisy and you will see this menu
[[File:Launcher_Menu.png]]

'''Admin Console (LAN)'''
This menu item downloads the ISY Admin Console directly from eisy

'''Admin Console (Cloud)'''
This menu item downloads the ISY Admin Console from the Universal Devices cloud servers

::Regardless of how you get to the ISY Admin Console (Cloud vs. LAN), the results are the same: Admin Console is brought up and connected directly to your eisy. Admin Console allows you to add/remove/change Z-Wave/INSTEON devices, make programs, and make configuration changes. The best source for what you can do with the Admin Console is our [[Main_Page#ISY_Cookbook | ISY (994) Cookbook]].

'''Polyglot V2 (Deprecated)'''
This is not available on eisy

'''Polyglot V3 (PG3)'''
This takes you to [[eisy:User_Guide#Polisy_.28PG3.29_Dashboard | Polyglot V3 (PG3) Dashboard]].

==Default Username and Password==
'''admin | admin''' is the default username/password for everything in eisy.

To change your password please see the [[Eisy:User_Guide#Change_Password | instructions below]].

==Setup ISY Portal for Remote Access/Alexa/GoogleHome/IFTTT==
* Please use UD Mobile which walks you through the seutp
* If you are migrating from 994, make sure you complete the [[eisy:User_Guide#Migrating_from_994_to_eisy | migration process]] from 994

Don't forget to check out all the things you can do with [[Main_Page#ISY_Portal:_Integration_with_Amazon_Echo.2FGoogle_Home.2FIFTTT | ISY Portal]].

='''Mobile App'''=
[[UD_Mobile | UD Mobile]] is everything you have ever dreamed of. It lets you control and monitor anything that's commissioned to your eisy, and it's FREE! 
UD Mobile is developed by Universal Devices. 
Forum support is available for [https://forum.universal-devices.com/forum/24-ud-mobile/ UD Mobile].

[[File:UDMobile_Featured.jpg]]

='''Device Support'''=

==Z-Wave Support==
# Simply plugin our awesome ZMatter USB dongle
# Go to the Admin Console | Configuration tab
# Check Z-Wave Support Checkbox
# Click the Save button
# Click the Reboot or Restart IoX button.
[[File:Polisy_ZWave.png]]

==Node Servers==
Pick from anything in the [[eisy:User_Guide#NodeServer_Store_Menu | Node Server Store]] and quench your thirst for integration!

==INSTEON Support==
# Connect the PLM to your eisy
eisy supports the following PLMs: 2412S, 2413S, 2413U, and 2448A7. If you have a 2413S (serial), you will need [https://www.universal-devices.com/product/serial-plm-kit/ our Serial PLM Kit]
# Go to the Admin Console | Configuration tab
# Check INSTEON Support Checkbox
# Click the Save button
# Click on the Reboot button. Here's the [[ISY-99i/ISY-26_INSTEON:How-To_Guide | INSTEON User Guide]].
[[File:Polisy_INSTEON.png]]

='''Migration'''=

==Background==
;Insteon
:The Eisy / Polisy implementation of Insteon is a port of the Insteon implementation on the ISY-994. Therefore, you will notice few if any differences.

;Z-Wave
:Our Original Z-Wave implementation is the certified version of Z-Wave on the ISY-994. This code was ported to Eisy / Polisy, but is being deprecated in favor of our new more functional implementation called ''ZMatter Z-Wave''.

:*The original implementation on Eisy / Polisy can use generic Z-Wave controllers such as the Zooz stick, or, it can use the ZMatter Z-Wave controller (either board or USB dongle).

:*The ZMatter Z-Wave implementation can only use the ZMatter Z-Wave controller (either board or USB dongle).

== What to Expect During Migration ==

; Insteon
: The Insteon network on ISY-994 will be seamlessly transferred to Eisy / Polisy. Your nodes, programs, and scenes using Insteon will remain unchanged.

; Z-Wave
: The Z-Wave network managed by ISY-994 will be migrated to the ZMatter Z-Wave implementation on Eisy / Polisy. The devices in the network will remain the same, but their representation in ISY may change.
:* Nodes
:: Z-Wave ISY Nodes will be reused whenever possible, but new nodes may be created as well.
:* Programs
:: Z-Wave ISY nodes in programs will be migrated, however, node actions and conditions may no longer be valid if the node's support for them has changed.
:* Scenes
:: Z-Wave ISY Nodes in scenes will be migrated, but those using native links (i.e. association) may require updates.

; Programs
:Programs and variables will be transferred seamlessly, but some exceptions may occur if ISY Nodes or their commands and/or status have changed.

; Network Resources
: All Network Resources will be migrated seamlessly, however, you will need to open and save each one individually.

; ISY Portal
: See [[ISY_Portal_Migrate_configurations_to_a_new_ISY | ISY Portal Migrate configurations to a new ISY]]

; Polyglot / Node Servers
: See [[Eisy:User_Guide#Migrating_Node_Servers_to_PG3x | Migrating Node Servers to PG3x]]

==Requirements==

# If you are migrating Insteon you must have a compatible PLM
#*Eisy / Polisy supports these PLMs: 2412S, 2413S, 2413U, and 2448A7
#*If you have a 2413S (serial), you will need our [https://www.universal-devices.com/product/serial-plm-kit/ Serial PLM Kit]
# If you are migrating your Z-Wave Network, you must have our [https://www.universal-devices.com/product/zmatter-usb-z-wave-matter-module-for-polisy-beta-copy/ ZMatter Z-Wave USB Dongle]
#*If you are using Polisy, you can alternatively use our [https://www.universal-devices.com/product/zmatter-z-wave-matter-module-for-polisy-beta/ ZMatter Z-Wave Board for Polisy]

== Preparing for Migration from ISY-994 ==

'''On your ISY-994'''

# Make sure the ISY-994 is upgraded to [https://forum.universal-devices.com/topic/33287-release-534-test-build-is-now-available 5.3.4],
# If you are migrating your Z-Wave network
#* You must be using a 500 Series Board in the ISY-994
#* Make a backup of your Z-Wave network (''Admin Console | Z-Wave | Backup'')
#* Make a backup of your ISY-994 (''Admin Console | File | Backup ISY'')
#* Power down your ISY-994 (very important). ISY-994 needs to be powered off because when you migrate, both your ISY-994 and Eisy / Polisy will think they are controlling the Z-Wave network.
# If you are not migrating your Z-Wave network
#* Make a backup of your ISY-994 (''Admin Console | File | Backup ISY'')

== Preparing for Migration from Eisy / Polisy ==

You can migrate locally on the same Eisy / Polisy or to another Eisy / Polisy.

'''On the Eisy / Polisy your are migrating from'''

# Make sure Eisy / Polisy is up to date
#* Go to Admin Console configuration page and select '''update packages'''
# If you are '''not''' migrating your Z-Wave network
#* Use (''Admin Console | File | Backup ISY'') to make a backup of your Eisy / Polisy
# If you are migrating your Z-Wave network
#* Leave your current Z-Wave board / dongle connected
#* Go to configuration tab in Admin Console and select "''Migration ZMatter Z-Wave''"
#* Choose the option that allows you to create a "migration" backup (first option)
#:* You will see a series of popup windows providing information and asking simple questions
#* Once you have your "migration" backup you are ready to migrate
#:* '''A migration backup is different than a regular backup.'''
#:* When a migration backup is restored it also migrates your Z-Wave network

== Migrating ==

'''On the Eisy / Polisy you are migrating to'''

# Do the appropriate preparation step (see above)
# Make sure Eisy / Polisy is up to date
#* Go to Admin Console configuration page and select '''update packages'''
# If you don't have a current backup, make a backup of your Eisy / Polisy (''Admin Console | File | Backup ISY'')
# If you are using Insteon, plug in the PLM
# If you are '''not''' migrating your Z-Wave network
#* Use (''Admin Console | File | Restore ISY'') to restore either your Eisy / Polisy backup or your ISY-994 backup
# If you are migrating your Z-Wave network
#* If you aren't already using it, plug in your ZMatter Z-Wave dongle and unplug any other Z-Wave dongle you may have been using.
#:* ''(Polisy only)'' If you have a ZMatter Z-Wave board then power down Polisy, add it, then power on again.
#* Use (''Admin Console | File | Restore ISY'') to restore your "migration" backup
#:* If you are migrating from Eisy / Polisy use the migration backup (e.g. ''"ISY-'''BackupWithZWaveMigration'''.v5.5.4__Sat 2023.01.21 09.07.44 AM"'')
#:* If you are migrating from ISY-994 use your ISY-994 backup
#* When Eisy / Polisy restarts, it automatically does the following:
#:* Writes you Z-Wave network into the ZMatter Z-Wave controller
#:* Interviews every Z-Wave device in the Z-Wave nework, creating/updating nodes, programs and scenes.
#::* This process can take anywhere from a few seconds to a few minutes for each device depending on the complexity of the device.
#* If you don't actually change your Z-Wave network by adding/removing Z-Wave devices after migration, you can back out the migration by connecting whatever Z-Wave dongle you were using before migration and restoring the backup you made prior to migration.
# If you are using Insteon
#* Go to the Admin Console configuration tab and make sure [[Eisy:User_Guide#INSTEON_Support | '''INSTEON Support is enabled''']] (default username/pwd = admin/admin)
#* If you are using a new PLM, [[ISY-99i/ISY-26_INSTEON:File_Menu#Restore_Modem_.28PLM.29 | '''Restore the PLM''']]
# Reconfigure any software utilizing to point to this Eisy / Polisy, restart the other software, if necessary.
# If you have ISY Portal on your 994
#* Follow [[ISY_Portal_Migrate_configurations_to_a_new_ISY | '''these instructions''']] to migrate your account, license, and Alexa/Google Home settings
#* This will also migrate all node server licenses from your Polisy to Eisy / Polisy
# If you are using Polyglot / Node Servers
#* See [[Eisy:User_Guide#Migrating_Node_Servers_to_PG3x | '''Migrating Node Servers to PG3x''']]
# If you migrated your Z-Wave Network then make a backup of it (''Z-Wave | Backup'')
# Make a backup of your newly configured IoX.

== Post Migration ==

# If you migrated your Z-Wave Network
#* If you have any Z-Wave nodes with a type of '''''(Placeholder)''''' it means the device has not been migrated yet.
#:* In most cases they are battery powered devices that were not awake during migration
#:* To migrate one of these devices, wake it up (see user manual for the device) and then do the following
#::* right+click on a placeholder node for the device, select ''Z-Wave | Synchronize | Update with Interview''
#:* When it completes do the same for the next device

==Migrating Node Servers to PG3x==
Migration is only possible with version 3.1.17 or later of PG3x. The version of PG3x that ships with eisy is currently 3.1.16 which does not support migration. Please upgrade packages first and make sure you are running version 3.1.17 of PG3x before attempting to migrate.

# Backup PG3 on Polisy.
# Restore from PG3 backup on eisy using the "Migrate from PG3 Backup" option.

Cautions:
* Node servers currently installed on eisy will be removed (and possibly replaced).
* Node servers migrated are left in the "stopped" state. You will need to manually start each one after migration.
* If the Polisy was configured to manage node servers on more than one IoX (say both Polisy IoP and i994) only one IoX will be migrated and you can't choose which one it will migrate.
* Node servers installed on the Polisy from the local node server store will likely fail to install on the eisy.
* Node server licenses should be migrated as part of the Portal migration step.

='''eisy (PG3) Dashboard'''=

You will be prompted with a security warning by your browser because eisy uses a self-signed certificate. Please ignore the warning.

[[File:Notsecure.png]]

You are then presented with the login screen. The default username is '''admin''' and default password is '''admin'''. Please make sure you change your default username/password once you login.

[[File:Login dialog.png]]

Once you have successfully logged into eisy, you will get the eisy Dashboard which is designed to be simple and functional.

==Change Password==

Starting with the eisy the password is managed through the Admin Console user/pass settings. Changing the '''admin''' password in Admin Console (via IoX Launcher) will update PG3x login and will keep the ISY on eisy in sync. It is no longer necessary to change the password in multiple places.

[[File:Eisy-AC-set_admin_user_and_pass1.jpg]] [[File:Eisy-AC-set_admin_user_and_pass2.jpg]]

==ISYs==

The eisy should automatically add the ISY running as '''localhost''' (or at IP 127.0.0.1) on the eisy. You can confirm this by clicking on "ISYs". It should show an ISY UUID with a checkmark next to it. Then click on "Edit Current ISY" to review/confirm information.

You can add/remove ISYs or IoXs through this menu.
# Click on the '''Add New ISY''' menu
# Fill out the entries as shown in the picture below
# Make sure you use HTTP and not HTTPS
[[File:Add_ISY.png]]

==NodeServer Store Menu==

This is where all the available node servers are listed. In order to install one of these node servers into ISY/IoX:
# Click on the name of the Node Server you wish to purchase/install
# Additional information about the Node Server will be displayed, including the purchase/install options available.

[[File:ns_purchase_options.png]]

There are 4 possible purchase options that may be available:
# Trial. Activating a trial license will make the Node Available for the trial period. When selected, the Activate button should change to an Install button.
# Free. Free Node Servers will simply show an Install button and are available to be immediately installed.
# Purchase. Clicking the Purchase button will re-direct you to the Portal purchasing system where you can purchase an license for the Node Server (see steps below).
# Subscription. Click the Purchase button for a subscription will re-direct you to the Portal purchasing system where you can purchase a license for a specific time period.

[[File:ns_purchase_info.png]]

The Purchase Info displays basic info about the node server and which ISY/IoX is currently being manages. Once you've confirmed this is what you wanted, click the Purchase button to re-direct to the Portal purchasing system. You may be asked to log-in to the Portal to complete the following steps.

[[File:ns_purchase.png]]

The Portal purchasing system will give you the option to select the type of license you wish to purchase. Use the drop down box to select the license and then click the button to continue with the payment options.

Once a node server license has been purchased, you will be re-directed back to PG3. Navigate back to the node server store and again select the node server you just purchased. The node server details page will now show an Install button instead of a Purchase button. Clicking the Install button will display the node server installation screen.

[[File:ns_install_details.png]]

If this is the first time installing this node server, you must select an empty slot before installing. If you have previously installed this node server, you will be given the option to re-install it into the slot where it is currently installed.

Once installed, it should show up in the PG3 Dashboard.

==Purchases==
This is where all your node server purchases show up. These node servers are tied to your eisy.

='''Multi Function Button'''=
eisy's power button acts as a multifunction button

==Update and Upgrade All the Packages==
Click the button '''once'''. Please consult [https://www.universal-devices.com/my-tickets/ support] before updating this route. 
Recommended route for updating is through Admin Console -> Configuration Tab -> "Upgrade Packages" button. ‎ 
NOTE: There is not a speaker on the eisy so there will not be any beeps on reboot. 
[[File:Eisy-System-Settings.jpg]]

==Go to WIFI Setup or Leave WIFI Setup mode==
Click the button '''twice'''.

==Reset Credentials==
Click the button '''three times'''
This action resets the following passwords to the default ('''admin/admin'''): 
*SSH
*Polyglot v2
*ISY on eisy(IoX) 
Be sure to change the passwords for these sections after you log-in again.

==Reset Networking==
Click the button '''4 times'''

==Reboot==
Click the button '''5 times'''

==Shutdown==
Click the button '''6 times'''

==Factory Reset==
Click the button '''10 times'''

Please wait 5 minutes after factory reset before attempting to reconnect to system. If System is not found by finder after the 5 minute wait period please reboot system by clicking the button '''5 times''' and waiting one minute for system to come online.

= Using eisy In Desktop Computer Mode =
Yes, you can use eisy as a beautiful desktop running a lean version of XFCE on FreeBSD!

== Attaching HDMI Ports ==
# Click the power button 6 times and wait for eisy to shutdown
# Attach your monitor(s) to the HDMI port(s)
# Click the power button to turn on eisy
# When you see the login prompt, login with your credentials (default = admin/admin)
# Type '''start.win''' at the prompt, accept the licenses, enter your credentials again and voila!

== Installing Development Packages ==
You can do all your node server development on eisy. It has a full set of tools to allow you to compile C/C++, run Python and Node.js, and pretty much anything you can imagine. To install development packages
* sudo udxops.sh install.dev.pkgs
Enjoy!!!

='''Troubleshooting'''=

==Can't Find eisy==
First and foremost, all VPN software block discovery of eisy on your network. As such, if you have a VPN software running, please turn it off.

If you have a modern router, eisy advertises itself as '''eisy.local''' on your network. As such, and in most cases, you should be able to find eisy at <nowiki>https://eisy.local:8443/desc</nowiki>. What you need to do is:
# In IoX Launcher, click on the '''Add''' button
# Enter '''<nowiki>https://eisy.local:8443/desc</nowiki>''' into the dialog
# Click on the '''OK''' button

If you are still having a hard time finding your eisy, it's best to check your router's DHCP client list and look for a device that has the same MAC address as the one the label at the bottom of your eisy. eisy's MAC address starts with '''00:21:b9'''.

Once you find the IP address for eisy, in this '''example''', 192.168.1.122, then
# In IoX Launcher, click on the '''Add''' button
# Enter '''<nowiki>https://192.168.1.122:8443/desc</nowiki>''' into the dialog. '''Note''' 192.168.1.122 is an example. You should use the IP address for your eisy.
# Click on the '''OK''' button

==Upgrade Process - As of July 2022==
Please see [https://forum.universal-devices.com/topic/37257-polisy-update-process-use-admin-console-upgrade-packages-button/ this important update (July 2022)]

Unless explicitly requested by Universal Devices, '''the SSH method of updating the eisy should be avoided'''. Due to recent updates to the underlying operating system, unexpected consequences are being experienced when users force a full package upgrade and update using SSH.

You can simply click on the power button once and eisy will automatically try to upgrade itself. You don't have to reboot.

Or, if you wish to use the Admin Console: e
IoX Launcher to open the ISY Finder window.

Once logged in navigate to:
* Configuration tab
* System

Then click: “Upgrade Packages”

This updating/upgrading process through Admin Console has been developed to handle downloading the proper packages from Universal Devices servers to update UD specific libraries and dependencies needed to keep the eisy operating efficiently and as designed.

Eisy:User Guide

2023-01-24T05:52:20Z

Chris: More complete/correct documentation for ZMatter Z-Wave migration

Welcome to our eisy corner: your one place for anything eisy!

='''Some Definitions!'''=
==ISY on Anything (IoX)==
IoX is shorthand notation for '''ISY on Anything'''. For the old timers, ISY is the code that runs on the 994, now running as an optimized and fast service on eisy and Polisy.

==Node Servers==
As you might already know, in ISY, everything is represented as a Node. These are things (or devices) that show up in your left navigation bar under ISY. A long time ago, these nodes were limited to INSTEON,X10/A10, Z-Wave, and Zigbee. Basically, protocols for which ISY994 had native support. We designed and developed node servers so that developers could integrate their things into ISY as nodes. And, hence, Node Servers: they serve nodes to ISY.

These nodes can be anything. They represent real devices such as Ring, Tesla, WiFi light bulbs, Ecobee, or they could be virtual such as calendars and climate services. Once a node is represented in ISY, then the whole ISY event based and programming environment are available to it. In short, Node Servers allow ISY to support pretty much any device or thing out there.

But, where do these node servers live? Well, you have come this far, so read on ...

==Polyglot==
Node servers have to run on some computing device. And, forcing each developer to have to come up with his/her own node server from scratch would be completely detrimental to our quest. So, we designed and developed Polyglot which is a framework that allows developers to develop their node servers with ease and confidence that all the plumbing/security and communications with ISY is handled automatically.

'''Polyglot version 3 (PG3)''' is the latest version of Polyglot which includes much enhanced functionality and, most importantly, enables the developers to charge for their node servers. PG3 is only available on eisy and Polisy. Polyglot V2 is not available on eisy.

==eisy | home ==
eisy is our own sbeautiful, powerful hardware/OS preconfigured and optimized to run Polyglot (and other things). So, for those of you non-geeks out there, we have taken all the geekiness out of Polyglot and provided you with a ready to run box. So, now that we got you excited, let's continue with setting up and using your eisy.

='''First Steps'''=

==Installation==
Installation is quite easy
* You can use UD Mobile which walks you through the setup. If not:
* Connect a Cat5e cable to eisy's Network Port and the other to your network. '''Note''': the network must initially be DHCP auto enabled
* Connect the power supply

==Accessing eisy==
IoX Launcher is the best method to find and access all of eisy's features
* Install [[Main_Page#Installing_the_Admin_Console_Icon_on_Your_Desktop | IoX Launcher]]
* Click on the row of the discovered eisy and you will see this menu
[[File:Launcher_Menu.png]]

'''Admin Console (LAN)'''
This menu item downloads the ISY Admin Console directly from eisy

'''Admin Console (Cloud)'''
This menu item downloads the ISY Admin Console from the Universal Devices cloud servers

::Regardless of how you get to the ISY Admin Console (Cloud vs. LAN), the results are the same: Admin Console is brought up and connected directly to your eisy. Admin Console allows you to add/remove/change Z-Wave/INSTEON devices, make programs, and make configuration changes. The best source for what you can do with the Admin Console is our [[Main_Page#ISY_Cookbook | ISY (994) Cookbook]].

'''Polyglot V2 (Deprecated)'''
This is not available on eisy

'''Polyglot V3 (PG3)'''
This takes you to [[eisy:User_Guide#Polisy_.28PG3.29_Dashboard | Polyglot V3 (PG3) Dashboard]].

==Default Username and Password==
'''admin | admin''' is the default username/password for everything in eisy.

To change your password please see the [[Eisy:User_Guide#Change_Password | instructions below]].

==Setup ISY Portal for Remote Access/Alexa/GoogleHome/IFTTT==
* Please use UD Mobile which walks you through the seutp
* If you are migrating from 994, make sure you complete the [[eisy:User_Guide#Migrating_from_994_to_eisy | migration process]] from 994

Don't forget to check out all the things you can do with [[Main_Page#ISY_Portal:_Integration_with_Amazon_Echo.2FGoogle_Home.2FIFTTT | ISY Portal]].

='''Mobile App'''=
[[UD_Mobile | UD Mobile]] is everything you have ever dreamed of. It lets you control and monitor anything that's commissioned to your eisy, and it's FREE! 
UD Mobile is developed by Universal Devices. 
Forum support is available for [https://forum.universal-devices.com/forum/24-ud-mobile/ UD Mobile].

[[File:UDMobile_Featured.jpg]]

='''Device Support'''=

==Z-Wave Support==
# Simply plugin our awesome ZMatter USB dongle
# Go to the Admin Console | Configuration tab
# Check Z-Wave Support Checkbox
# Click the Save button
# Click the Reboot or Restart IoX button.
[[File:Polisy_ZWave.png]]

==Node Servers==
Pick from anything in the [[eisy:User_Guide#NodeServer_Store_Menu | Node Server Store]] and quench your thirst for integration!

==INSTEON Support==
# Connect the PLM to your eisy
eisy supports the following PLMs: 2412S, 2413S, 2413U, and 2448A7. If you have a 2413S (serial), you will need [https://www.universal-devices.com/product/serial-plm-kit/ our Serial PLM Kit]
# Go to the Admin Console | Configuration tab
# Check INSTEON Support Checkbox
# Click the Save button
# Click on the Reboot button. Here's the [[ISY-99i/ISY-26_INSTEON:How-To_Guide | INSTEON User Guide]].
[[File:Polisy_INSTEON.png]]

='''Migration'''=

==Background==
;Insteon
:The Eisy / Polisy implementation of Insteon is a port of the Insteon implementation on the ISY-994. Therefore, you will notice few if any differences.

;Z-Wave
:Our Original Z-Wave implementation is the certified version of Z-Wave on the ISY-994. This code was ported to Eisy / Polisy, but is being deprecated in favor of our new more functional implementation called ''ZMatter Z-Wave''.

:*The original implementation on Eisy / Polisy can use generic Z-Wave controllers such as the Zooz stick, or, it can use the ZMatter Z-Wave controller (either board or USB dongle).

:*The ZMatter Z-Wave implementation can only use the ZMatter Z-Wave controller (either board or USB dongle).

== What to Expect During Migration ==

; Insteon
: The Insteon network on ISY-994 will be seamlessly transferred to Eisy / Polisy. Your nodes, programs, and scenes using Insteon will remain unchanged.

; Z-Wave
: The Z-Wave network managed by ISY-994 will be migrated to the ZMatter Z-Wave implementation on Eisy / Polisy. The devices in the network will remain the same, but their representation in ISY may change.
:* Nodes
:: Z-Wave ISY Nodes will be reused whenever possible, but new nodes may be created as well.
:* Programs
:: Z-Wave ISY nodes in programs will be migrated, however, node actions and conditions may no longer be valid if the node's support for them has changed.
:* Scenes
:: Z-Wave ISY Nodes in scenes will be migrated, but those using native links (i.e. association) may require updates.

; Programs
:Programs and variables will be transferred seamlessly, but some exceptions may occur if ISY Nodes or their commands and/or status have changed.

; Network Resources
: All Network Resources will be migrated seamlessly, however, you will need to open and save each one individually.

; ISY Portal
: See [[ISY_Portal_Migrate_configurations_to_a_new_ISY | ISY Portal Migrate configurations to a new ISY]]

; Polyglot / Node Servers
: See [[Eisy:User_Guide#Migrating_Node_Servers_to_PG3x | Migrating Node Servers to PG3x]]

==Requirements==

# If you are migrating Insteon you must have a compatible PLM
#*Eisy / Polisy supports these PLMs: 2412S, 2413S, 2413U, and 2448A7
#*If you have a 2413S (serial), you will need our [https://www.universal-devices.com/product/serial-plm-kit/ Serial PLM Kit]
# If you are migrating your Z-Wave Network, you must have our [https://www.universal-devices.com/product/zmatter-usb-z-wave-matter-module-for-polisy-beta-copy/ ZMatter Z-Wave USB Dongle]
#*If you are using Polisy, you can alternatively use our [https://www.universal-devices.com/product/zmatter-z-wave-matter-module-for-polisy-beta/ ZMatter Z-Wave Board for Polisy]

== Preparing for Migration from ISY-994 ==

'''On your ISY-994'''

# Make sure the ISY-994 is upgraded to [https://forum.universal-devices.com/topic/33287-release-534-test-build-is-now-available 5.3.4],
# If you are migrating your Z-Wave network
#* You must be using a 500 Series Board in the ISY-994
#* Make a backup of your Z-Wave network (''Admin Console | Z-Wave | Backup'')
#* Make a backup of your ISY-994 (''Admin Console | File | Backup ISY'')
#* Power down your ISY-994 (very important). ISY-994 needs to be powered off because when you migrate, both your ISY-994 and Eisy / Polisy will think they are controlling the Z-Wave network.
# If you are not migrating your Z-Wave network
#* Make a backup of your ISY-994 (''Admin Console | File | Backup ISY'')

== Preparing for Migration from Eisy / Polisy ==

You can migrate locally on the same Eisy / Polisy or to another Eisy / Polisy.

'''On the Eisy / Polisy your are migrating from'''

# Make sure Eisy / Polisy is up to date
#* Go to Admin Console configuration page and select '''update packages'''
# If you are '''not''' migrating your Z-Wave network
#* Use (''Admin Console | File | Backup ISY'') to make a backup of your Eisy / Polisy
# If you are migrating your Z-Wave network
#* Leave your current Z-Wave board / dongle connected
#* Go to configuration tab in Admin Console and select "''Migration ZMatter Z-Wave''"
#* Choose the option that allows you to create a "migration" backup (first option)
#:* You will see a series of popup windows providing information and asking simple questions
#* Once you have your "migration" backup you are ready to migrate
#:* '''A migration backup is different than a regular backup.'''
#:* When a migration backup is restored it also migrates your Z-Wave network

== Migrating ==

'''On the Eisy / Polisy you are migrating to'''

# Do the appropriate preparation step (see above)
# Make sure Eisy / Polisy is up to date
#* Go to Admin Console configuration page and select '''update packages'''
# If you don't have a current backup, make a backup of your Eisy / Polisy (''Admin Console | File | Backup ISY'')
# If you are using Insteon, plug in the PLM
# If you are '''not''' migrating your Z-Wave network
#* Use (''Admin Console | File | Restore ISY'') to restore either your Eisy / Polisy backup or your ISY-994 backup
# If you are migrating your Z-Wave network
#* If you aren't already using it, plug in your ZMatter Z-Wave dongle and unplug any other Z-Wave dongle you may have been using.
#:* ''(Polisy only)'' If you have a ZMatter Z-Wave board then power down Polisy, add it, then power on again.
#* Use (''Admin Console | File | Restore ISY'') to restore your "migration" backup
#:* If you are migrating from Eisy / Polisy use the migration backup (e.g. ''"ISY-'''BackupWithZWaveMigration'''.v5.5.4__Sat 2023.01.21 09.07.44 AM"'')
#:* If you are migrating from ISY-994 use your ISY-994 backup
#* When Eisy / Polisy restarts, it automatically does the following:
#:* Writes you Z-Wave network into the ZMatter Z-Wave controller
#:* Interviews every Z-Wave device in the Z-Wave nework, creating/updating nodes, programs and scenes.
#::* This process can take anywhere from a few seconds to a few minutes for each device depending on the complexity of the device.
#* If you don't actually change your Z-Wave network by adding/removing Z-Wave devices after migration, you can back out the migration by connecting whatever Z-Wave dongle you were using before migration and restoring the backup you made prior to migration.
# If you are using Insteon
#* Go to the Admin Console configuration tab and make sure [[Eisy:User_Guide#INSTEON_Support | '''INSTEON Support is enabled''']] (default username/pwd = admin/admin)
#* If you are using a new PLM, [[ISY-99i/ISY-26_INSTEON:File_Menu#Restore_Modem_.28PLM.29 | '''Restore the PLM''']]
# Reconfigure any software utilizing to point to this Eisy / Polisy, restart the other software, if necessary.
# If you have ISY Portal on your 994
#* Follow [[ISY_Portal_Migrate_configurations_to_a_new_ISY | '''these instructions''']] to migrate your account, license, and Alexa/Google Home settings
#* This will also migrate all node server licenses from your Polisy to Eisy / Polisy
# If you are using Polyglot / Node Servers
#* See [[Eisy:User_Guide#Migrating_Node_Servers_to_PG3x | '''Migrating Node Servers to PG3x''']]
# Make a backup of your newly configured IoX.

== Post Migration ==

# If you migrated your Z-Wave Network
#* If you have any Z-Wave nodes with a type of '''''(Placeholder)''''' it means the device has not been migrated yet.
#:* In most cases they are battery powered devices that were not awake during migration
#:* To migrate one of these devices, wake it up (see user manual for the device) and then do the following
#::* right+click on a placeholder node for the device, select ''Z-Wave | Synchronize | Update with Interview''
#:* When it completes do the same for the next device

==Migrating Node Servers to PG3x==
Migration is only possible with version 3.1.17 or later of PG3x. The version of PG3x that ships with eisy is currently 3.1.16 which does not support migration. Please upgrade packages first and make sure you are running version 3.1.17 of PG3x before attempting to migrate.

# Backup PG3 on Polisy.
# Restore from PG3 backup on eisy using the "Migrate from PG3 Backup" option.

Cautions:
* Node servers currently installed on eisy will be removed (and possibly replaced).
* Node servers migrated are left in the "stopped" state. You will need to manually start each one after migration.
* If the Polisy was configured to manage node servers on more than one IoX (say both Polisy IoP and i994) only one IoX will be migrated and you can't choose which one it will migrate.
* Node servers installed on the Polisy from the local node server store will likely fail to install on the eisy.
* Node server licenses should be migrated as part of the Portal migration step.

='''eisy (PG3) Dashboard'''=

You will be prompted with a security warning by your browser because eisy uses a self-signed certificate. Please ignore the warning.

[[File:Notsecure.png]]

You are then presented with the login screen. The default username is '''admin''' and default password is '''admin'''. Please make sure you change your default username/password once you login.

[[File:Login dialog.png]]

Once you have successfully logged into eisy, you will get the eisy Dashboard which is designed to be simple and functional.

==Change Password==

Starting with the eisy the password is managed through the Admin Console user/pass settings. Changing the '''admin''' password in Admin Console (via IoX Launcher) will update PG3x login and will keep the ISY on eisy in sync. It is no longer necessary to change the password in multiple places.

[[File:Eisy-AC-set_admin_user_and_pass1.jpg]] [[File:Eisy-AC-set_admin_user_and_pass2.jpg]]

==ISYs==

The eisy should automatically add the ISY running as '''localhost''' (or at IP 127.0.0.1) on the eisy. You can confirm this by clicking on "ISYs". It should show an ISY UUID with a checkmark next to it. Then click on "Edit Current ISY" to review/confirm information.

You can add/remove ISYs or IoXs through this menu.
# Click on the '''Add New ISY''' menu
# Fill out the entries as shown in the picture below
# Make sure you use HTTP and not HTTPS
[[File:Add_ISY.png]]

==NodeServer Store Menu==

This is where all the available node servers are listed. In order to install one of these node servers into ISY/IoX:
# Click on the name of the Node Server you wish to purchase/install
# Additional information about the Node Server will be displayed, including the purchase/install options available.

[[File:ns_purchase_options.png]]

There are 4 possible purchase options that may be available:
# Trial. Activating a trial license will make the Node Available for the trial period. When selected, the Activate button should change to an Install button.
# Free. Free Node Servers will simply show an Install button and are available to be immediately installed.
# Purchase. Clicking the Purchase button will re-direct you to the Portal purchasing system where you can purchase an license for the Node Server (see steps below).
# Subscription. Click the Purchase button for a subscription will re-direct you to the Portal purchasing system where you can purchase a license for a specific time period.

[[File:ns_purchase_info.png]]

The Purchase Info displays basic info about the node server and which ISY/IoX is currently being manages. Once you've confirmed this is what you wanted, click the Purchase button to re-direct to the Portal purchasing system. You may be asked to log-in to the Portal to complete the following steps.

[[File:ns_purchase.png]]

The Portal purchasing system will give you the option to select the type of license you wish to purchase. Use the drop down box to select the license and then click the button to continue with the payment options.

Once a node server license has been purchased, you will be re-directed back to PG3. Navigate back to the node server store and again select the node server you just purchased. The node server details page will now show an Install button instead of a Purchase button. Clicking the Install button will display the node server installation screen.

[[File:ns_install_details.png]]

If this is the first time installing this node server, you must select an empty slot before installing. If you have previously installed this node server, you will be given the option to re-install it into the slot where it is currently installed.

Once installed, it should show up in the PG3 Dashboard.

==Purchases==
This is where all your node server purchases show up. These node servers are tied to your eisy.

='''Multi Function Button'''=
eisy's power button acts as a multifunction button

==Update and Upgrade All the Packages==
Click the button '''once'''. Please consult [https://www.universal-devices.com/my-tickets/ support] before updating this route. 
Recommended route for updating is through Admin Console -> Configuration Tab -> "Upgrade Packages" button. ‎ 
NOTE: There is not a speaker on the eisy so there will not be any beeps on reboot. 
[[File:Eisy-System-Settings.jpg]]

==Go to WIFI Setup or Leave WIFI Setup mode==
Click the button '''twice'''.

==Reset Credentials==
Click the button '''three times'''
This action resets the following passwords to the default ('''admin/admin'''): 
*SSH
*Polyglot v2
*ISY on eisy(IoX) 
Be sure to change the passwords for these sections after you log-in again.

==Reset Networking==
Click the button '''4 times'''

==Reboot==
Click the button '''5 times'''

==Shutdown==
Click the button '''6 times'''

==Factory Reset==
Click the button '''10 times'''

Please wait 5 minutes after factory reset before attempting to reconnect to system. If System is not found by finder after the 5 minute wait period please reboot system by clicking the button '''5 times''' and waiting one minute for system to come online.

= Using eisy In Desktop Computer Mode =
Yes, you can use eisy as a beautiful desktop running a lean version of XFCE on FreeBSD!

== Attaching HDMI Ports ==
# Click the power button 6 times and wait for eisy to shutdown
# Attach your monitor(s) to the HDMI port(s)
# Click the power button to turn on eisy
# When you see the login prompt, login with your credentials (default = admin/admin)
# Type '''start.win''' at the prompt, accept the licenses, enter your credentials again and voila!

== Installing Development Packages ==
You can do all your node server development on eisy. It has a full set of tools to allow you to compile C/C++, run Python and Node.js, and pretty much anything you can imagine. To install development packages
* sudo udxops.sh install.dev.pkgs
Enjoy!!!

='''Troubleshooting'''=

==Can't Find eisy==
First and foremost, all VPN software block discovery of eisy on your network. As such, if you have a VPN software running, please turn it off.

If you have a modern router, eisy advertises itself as '''eisy.local''' on your network. As such, and in most cases, you should be able to find eisy at <nowiki>https://eisy.local:8443/desc</nowiki>. What you need to do is:
# In IoX Launcher, click on the '''Add''' button
# Enter '''<nowiki>https://eisy.local:8443/desc</nowiki>''' into the dialog
# Click on the '''OK''' button

If you are still having a hard time finding your eisy, it's best to check your router's DHCP client list and look for a device that has the same MAC address as the one the label at the bottom of your eisy. eisy's MAC address starts with '''00:21:b9'''.

Once you find the IP address for eisy, in this '''example''', 192.168.1.122, then
# In IoX Launcher, click on the '''Add''' button
# Enter '''<nowiki>https://192.168.1.122:8443/desc</nowiki>''' into the dialog. '''Note''' 192.168.1.122 is an example. You should use the IP address for your eisy.
# Click on the '''OK''' button

==Upgrade Process - As of July 2022==
Please see [https://forum.universal-devices.com/topic/37257-polisy-update-process-use-admin-console-upgrade-packages-button/ this important update (July 2022)]

Unless explicitly requested by Universal Devices, '''the SSH method of updating the eisy should be avoided'''. Due to recent updates to the underlying operating system, unexpected consequences are being experienced when users force a full package upgrade and update using SSH.

You can simply click on the power button once and eisy will automatically try to upgrade itself. You don't have to reboot.

Or, if you wish to use the Admin Console: e
IoX Launcher to open the ISY Finder window.

Once logged in navigate to:
* Configuration tab
* System

Then click: “Upgrade Packages”

This updating/upgrading process through Admin Console has been developed to handle downloading the proper packages from Universal Devices servers to update UD specific libraries and dependencies needed to keep the eisy operating efficiently and as designed.

ISY-99i/ISY-26 INSTEON:File Menu

2023-01-13T02:06:14Z

Chris: /* Set Userid/Password */

Please see Figure 6 for all File Menu options.

[[Image:File_Menu.gif|frame|none|''Figure 6. File Menu'']]

==Logon==

The Logon option will be enabled if you are not connected to the ISY. The system will prompt you that you have lost the connection and you must login. Once you select this option you will be required to enter your user name and password.

==Set Userid/Password==

Once this menu option is selected the user can change the user name and password. The new user name and password should be typed in the appropriate fields.
Please make sure you remember the new user name and password as the default account of user name/password admin/admin will no longer work in future logins.
* Both User ID and password must be entered.
* User ID and passwords are case sensitive.
* User ID must be between 1 and 32 characters long
* User ID must not contain '''< > & :'''
* Password must be between 5 and 20 characters long
* Password must not contain '''< >'''

==Backup ISY==

Selecting this menu saves the entire ISY configuration in a file. The user will be prompted to select or type the storage location and name the configuration file. Note the location and file name for future use.
The following system information will be saved to this file:
#Time Zone, Latitude, and Longitude
#Notification recipients
#Programs
#INSTEON devices information and scene memberships
#INSTEON devices links
#Scenes information

==Restore ISY==

Selecting this menu option allows the user to locate and select the ISY’s backup configuration file. Upon completion, this operation reboots ISY and closes your browser.

This option only restores the settings and has no impact on the underlying INSTEON devices and their configurations. If you wish to restore INSTEON device configurations, links, and settings please follow up this operation with Restore Devices menu option upon ISY reboot.

==Restore Devices==

Selecting this menu option starts the ISY to use the current configurations settings stored within ISY, and reprograms all the INSTEON devices based on them. Upon completion, this operation reboots ISY and closes Admin Console.
This operation is most useful when a PLM is replaced or if INSTEON devices and their logical representations on ISY are out of synch. This scenario might happen if INSTEON devices are manually linked without using ISY’s GUI. Please follow the instructions below:

#If you are replacing a PLM:
## Please make sure you '''reboot ISY with the new PLM before''' doing anything else
## Click on '''File | Restore ISY''' and restore a good backup. If you are replacing a defective PLM, choose a backup from right before the PLM died. This is a '''very important step'''
## Once ISY reboots, wait for the query to complete
# If you have PRO series, click on the '''Battery''' icon on the top right corner of the tool bar. This prevents ISY from trying to restore battery operated devices since they are sleeping and will not respond
# Please make sure ISY is in '''Ready''' state
# Click on '''File | Restore Devices''' - this will take a long while
# In case ISY cannot communicate (or decides not to if an RF device/PRO Series) during the process, you will have a series of nodes with green 1011 icons in the device tree. For each one of those nodes:
## If an RF device, ensure that the device is in Programming mode
## Right mouse click | '''Write pending updates''' or '''Write updates to device'''...
## For some newer INSTEON devices, you might have to repeat this step a couple of times since some devices may not go into linking mode
# If you have PRO series, click on the battery icon on the toolbar so that ISY goes back to normal mode

==Restore Modem (PLM)==

===Replace Modem (PLM)===

This operation is most useful when you need to replace a defective PLM and the ISY is rebooted with a new PLM.
When the communication links were established via the Link Management Menu, the PLM and INSTEON devices adds each device addresses it is linked to, in its own link table.

The ISY also reads and stores the PLM’s address at boot up. The ISY stores all the configurations settings of the lighting network. If you are replacing a PLM the ISY will have the old PLM address link stored in it.

'''Warning:''' ''Never replace your PLM while the ISY is running because it will assume it is still connected with the old PLM. The ISY will appear to work, but it will be writing the address of the old PLM into the device links, thus you will not see devices updates etc.''

If this menu option is selected, the ISY goes through all INSTEON devices looking for old and new PLM address links. If an old PLM address link is found, it replaces them with the address of the new PLM and adds the corresponding device link to the new PLM.

To replace a PLM:
*Unplug ISY from the power outlet
*Unplug the PLM from ISY and power outlet
*Connect ISY’s port A to the new PLM
*Plug the new PLM into a power outlet
*Plug ISY into a power outlet
*Go to Admin Console and wait for system initialization to complete
**If you have '''PRO Series''', click on the Battery icon at the top. This will prevent ISY from trying to update programming on your RF devices which are probably in sleep mode
*Click on the '''Restore Modem (PLM)''' menu option
**In case ISY cannot communicate (or decides not to if an RF device/PRO Series) during the process, you will have a series of nodes with green 1011 icons in the device tree. For each one of those nodes:
***If an RF device, ensure that the device is in Programming mode
***Right mouse click | Write pending updates ...

'''If the above procedure fails on many of your devices, it's highly recommended that you follow the instructions for
[[ISY-99i/ISY-26_INSTEON:File_Menu#Restore_Devices | ''Restore Devices'']].'''

==Delete Modem (PLM)==

'''Before selecting this function, create a backup ISY file.'''

The modem (PLM) is the communication bridge between the ISY and the INSTEON devices. Without the modem and the links you cannot control or get status from the INSTEON devices.
When the communication links were established via the Link Management Menu, the PLM and INSTEON devices adds each device addresses it is linked to, in its own link table. The ISY also stores the PLM’s address.

If you need to remove a modem from your lighting network, select this function. It will disconnect the ISY from the PLM and the PLM from all INSTEON devices in the network, removing all the links between them. This ensures orphaned links do not exist in the INSTEON devices when the PLM is removed from the lighting network. Also, it ensures the ISY is not looking for the removed PLM.

Orphaned links are links between two devices where one is no longer in the network. Orphaned links will affect the lighting network performance. A device with an orphaned link to a missing PLM will create unnecessary network traffic by trying to communicate with the PLM multiple times. This in effect will slow down the network response.

All ISY programs, Triggers or Schedules, will not work when you remove the modem from the lighting network. Also, the actual status of all INSTEON devices will not be synchronized with the status reported on the screen.

==Automatic Writes to Devices (ISY99i Pro)==

In this mode changes are automatically written to your devices. Toggle this button off to turn off automatic writes.

Toggle this button On to write all pending changes to all devices.

* If ''Automatic Writes to Battery Powered Devices'' is disabled those devices will not be updated.

* At anytime you may write changes to a single device by selecting ''Write Updates to Device'' from the device context menu.

* The ISY keeps track of all your changes, this determines when they will be written.

==Automatic Writes to Battery Powered Devices (ISY99i Pro)==

In this mode changes are automatically written to your devices. Toggle this button off to turn off automatic writes to battery powered devices.

Toggle this button On to write all pending changes to all battery powered devices.

* At anytime you may write changes to a single device by selecting ''Write Updates to Device'' from the device context menu.

* The ISY keeps track of all your changes, this determines when they will be written.

==Enable/Disable Internet Access==

In order to achieve remote/internet access, you will need to setup your router for port forwarding. Port forwarding allows the ISY’s port to be seen over the internet.

The controller default setting is with internet access disabled. If you would like to enable internet access to the controller select this option. It is reversible and you will be presented with the Disable Internet Access menu option.
For a list of supported routers, please see the [[ISY-99i/ISY-26 INSTEON:Supported Remote Access Routers|Supported Remote Access Routers]] page.

If you do not have one of the routers listed above, please contact us and we’ll walk you through setting up your router (port forwarding) manually.

==Exit==

Once this menu option is selected this application will end and the browser window will close.

----
[[ISY-26 INSTEON|ISY-26 INSTEON]] '''/'''
[[ISY-99i Series INSTEON|ISY-99i Series INSTEON]] ''':'''
[[ISY-99i/ISY-26 INSTEON:User Guide|User Guide]]

Polisy Developers:ISY:API:NLS:Language Support

2022-12-01T00:09:11Z

Chris: Added NDN and ND support for Device Name

[[Polisy_Developers | Polisy Developers]] : [[Polisy_Developers:ISY | ISY]] : [[Polisy_Developers:ISY:API | API]] : National Language Support (NLS)

== National Language Support (NLS) ==
NLS support is defined for a node server by the set of properties files in the '''/nls''' subdirectory.
The files contain the name/value pairs used by the clients and the ISY to display commands, values,
controls etc.. All NLS names must be in uppercase.

A naming convention is used to organize these values.

=== Naming Convention Terminology ===
The following table shows the various attributes from XML node definitions, and editors that are
used in this chapter to describe how to build the name of a particular NLS value.

{| border="1" style="border-collapse:collapse" cellpadding="10"
|- style="vertical-align: top;"
|<node.nls>
|The 'nls' attribute specified when adding or changing a node.

e.g. /rest/ns/5/nodes/n005_dimmer_2/add/MyDimmer?primary=n005_dimmer_1&name=Dimmer 2&'''nls=012B'''
|- style="vertical-align: top;"
|<nodedef.id>
|The 'id' attribute of a node definition.

e.g. <nodeDef '''id="Thermostat"''' nls="tstat">
|- style="vertical-align: top;"
|<nodedef.nls>
|The 'nls' attribute of a node definition.

e.g. <nodeDef id="Thermostat" '''nls="tstat"'''>
|- style="vertical-align: top;"
|<editor.id>
|The 'id' attribute of an editor

e.g <editor '''id="I_OL"'''>
|- style="vertical-align: top;"
|<range.nls>
|The 'nls' attribute of a range

e.g. <range uom="25" subset="0-32" '''nls="IX_I_RR"''' />
|- style="vertical-align: top;"
|<st.id>
|The 'id' attribute of a status

e.g. <st '''id="CLIHUM"''' editor="I_TSTAT_HUM" />
|- style="vertical-align: top;"
|<cmd.id>
|The 'id' attribute of a command

e.g. <cmd '''id="DON"'''>
|- style="vertical-align: top;"
|<p.id>
|The 'id' attribute of a command parameter

e.g. 
|-
|}

=== Programs ===

See [[Polisy_Developers:ISY:API:NLS:Formatting_for_Programs | Formatting for Programs]]

=== Device name ===
The same node definition may be used for different products/models of a device. For example,
there may be many different models of a dimmer lamp, but they are functionally equivalent and
therefore use the same node definition. The device name is used to specify the actual product
name/model etc. of the device for a specific node.

<pre>
DEV-<node.nls>-NAME
NDN-<nodedef.nls>-NAME
ND-<nodedef.id>-NAME

e.g.
DEV-0102-NAME = (2475D) In-LineLinc Dimmer
NDN-Dimmer-NAME = Dimmer
ND-MyDimmer-NAME = Dimmer
</pre>

=== Icons ===
The format and lookup order of the NLS entry for icons is:

<pre>
DEV-<node.nls>-ICON
NDN-<nodedef.nls>-ICON
ND-<nodedef.id>-ICON
e.g.
DEV-0341-ICON = Thermostat
NDN-TStat-ICON = Thermostat
ND-MyThermostat-ICON = Thermostat
</pre>

See [[Polisy_Developers:ISY:API:Appendix:Icons | Icons]] for the list of supported icons

=== Status Names ===
Some status values require different names for different node definitions. For example, ST for a dimmer should show up as 'Lamp', but ST for a drapery motor should show up as 'Drapes'. The format and lookup order of the NLS entry is:

<pre>
ST-<nodedef.nls>-<st.id>-NAME
GEN-<nodedef.nls>-<st.id>-NAME
ST-<st.id>-NAME
e.g.
ST-ST-NAME = Lamp
ST-MYDRAPES-ST-NAME = Drapes
</pre>

=== Command Names ===
The format and lookup order of the NLS entry for command names is:

<pre>
CMD-<nodedef.nls>-<cmd.id>-NAME
CMD-<cmd.id>-NAME

e.g.
CMD-DON-NAME = On
CMD-MYDRAPES-DON-NAME = Open
</pre>

=== Command Parameter Names ===
The format and lookup order of the NLS entry for command parameter names is:

<pre>
GEN-<p.nls>-NAME
CMDP-<nodedef.nls>-<editor.id>-<p.id>-NAME
CMDPN-<nodedef.nls>-<p.id>-NAME
GEN-<nodedef.nls>-<p.id>-NAME
CMDP-<editor.id>-<p.id>-NAME
CMDP-<p.id>-NAME

e.g.
GEN-MYTIMER001-NAME = On/Off Timer
</pre>

=== Node Definition ===
<pre>ND-<nodedef.id>-NAME</pre>

=== Name mapped Values (Index, Percent) ===
Some integer values may be displayed as names instead of numeric values. Index values (uom 25),
and some percent values are commonly made into names. For example, displaying the values 0-31
for Insteon Ramp Rates is not very meaningful compared to names indicating the actual durations.
'On' and 'Off' are often displayed for percentage values, while the remaining values 1-99 are
usually displayed numerically.

The format of the NLS entry for mapped values is:

<pre>
<range.nls>-<value>

e.g. Insteon Ramp Rates

<range id="I_RR" uom="25" subset="0-31" nls="IX_I_RR" />

IX_I_RR-0 = 9.0 minutes
IX_I_RR-1 = 8.0 minutes
...
IX_I_RR-31 = 0.1 seconds
</pre>

Polisy Developers:ZMatter:ZWave:Events

2022-11-20T16:15:55Z

Chris:

[[Polisy Developers]] : [[Polisy_Developers:ZMatter | ZMatter]] : [[Polisy_Developers:ZMatter:ZWave | Z-Wave]] : Events

All events sent by ZMatter Z-Wave are in the following format:

<Event seqnum="8" sid="uuid:27">
<control>'''_25'''</control>
<action>'''6.4'''</action>
<node/>
<eventInfo>
'''<info uid="34" curFrag="10" totalFrag="2128" reason="" wait="" />'''
</eventInfo>
</Event>

{|
|- style="vertical-align:top;"
|'''''control''''' || Always "'''_25'''" for ZMatter Z-Wave events
|- style="vertical-align:top;"
|'''''action''''' || The specific event (e.g. "'''2.3'''" for Exclude a Z-Wave device)
|- style="vertical-align:top;"
|'''''eventInfo''''' || Event specific XML
|-
|}

== Include/Exclude Status ==

"'''2.1'''"

Include/Exclude not active

----
"'''2.2'''"

Include a Z-Wave device

----
"'''2.3'''"

Exclude a Z-Wave device

----
"'''2.4'''" ''(not currently used)''

As primary, replicate to controller and make it the new primary

----
"'''2.5'''" ''(not currently used)''

Learn mode

----
"'''2.6'''"

Replace failed node (similar to Include a Z-Wave device)

----
"'''2.7'''"

Controller is resetting

== General Status ==

"'''3.x'''" ''(not currently used)''

== General Error ==

"'''4.8'''"

Failed to replace a failed Z-Wave node

----
"'''4.9'''"

Failed to remove a failed Z-Wave node

== S2 Inclusion Events ==

"'''5.1'''"

No longer processing S2 Inclusion

----
"'''5.2'''"

Actively processing S2 Inclusion

----
"'''5.3'''"

'''<grant id="17" keymask="0x87" />'''

Requests the client to ask the user to specify the set of keys to grant the device.

{|
|- style="vertical-align:top;"
|'''''id''''' || Z-Wave Node ID of the device
|- style="vertical-align:top;"
|'''''keymask'''''
| A bitmask indicating the set of keys requested:
:: 0x80 - S0 Security
:: 0x01 - S2 Unauthenticated
:: 0x02 - S2 Authenticated
:: 0x04 - S2 Access
|-
|}

----
"'''5.4'''"

'''<verify id="17" key="51120-42991-08200-16940-32401-15092-37180-22568" />'''

Requests the client to ask the user to verify the given key matches the DSK on the device

{|
|'''''id''''' || Z-Wave Node ID of the device
|-
|'''''key''''' || The key to be verified
|-
|}

== OTA Firmware Upgrade ==

All OTA events receive the same event info format:

'''<info uid="34" curFrag="10" totalFrag="2128" reason="" wait="" />'''

Some of the values may be blank based on the type of OTA message sent.

{|
|- style="vertical-align:top;"
|'''''uid''''' || Z-Wave Node ID of the device
|- style="vertical-align:top;"
|'''''curFrag''''' || The current fragment being sent
|- style="vertical-align:top;"
|'''''totalFrag''''' || The total number of fragments
|- style="vertical-align:top;"
|'''''reason'''''
|
:: 254 - Manually restart the device
:: 255 - The device will automatically restart
|- style="vertical-align:top;"
|'''''wait''''' || The total number of seconds to wait before manually restarting the device (for reason 254)
|-
|}

----
"'''6.1'''"

'''<info uid="" curFrag="" totalFrag="" reason="" wait="" />'''

OTA processing is not active

----
"'''6.2'''"

'''<info uid="34" curFrag="" totalFrag="" reason="" wait="" />'''

Reading firmware file

----
"'''6.3'''"

'''<info uid="34" curFrag="" totalFrag="" reason="" wait="" />'''

OTA processing is upgrading device

----
"'''6.4'''"

'''<info uid="34" curFrag="10" totalFrag="2128" reason="" wait="" />'''

OTA fragment sent

----
"'''6.5'''"

'''<info uid="34" curFrag="2128" totalFrag="2128" reason="254" wait="120" />'''

OTA processing finished successfully

----
"'''6.6'''"

'''<info uid="34" curFrag="2128" totalFrag="2128" reason="" wait="" />'''

OTA processing failed

== Z-Wave Dongle Backup/Restore ==

"'''7.1'''"

'''<options><files zwave500Series="false" zmatter="true" /><dongle zwaveOther="false" zmatter="true" /></options>'''

Backup/Restore options have changed. This event is only sent if a Z-Wave dongle has been connected or disconnected.

----
"'''7.2'''"

Backup a ZMatter Z-Wave dongle

{|
|"'''''7.2.1'''''" || Backup Started
|-
|"'''''7.2.2'''''" || Backup Succeeded
|-
|"'''''7.2.3'''''" || Backup Failed
|-
|}

----
"'''7.3'''"

Backup a non-ZMatter Z-Wave dongle (700 Series)

{|
|"'''''7.3.1'''''" || Backup Started
|-
|"'''''7.3.2'''''" || Backup Succeeded
|-
|"'''''7.3.3'''''" || Backup Failed
|}

----
"'''7.4'''"

Restore a ZMatter Z-Wave dongle

{|
|"'''''7.4.1'''''" || Restore Started
|-
|"'''''7.4.2'''''" || Restore Succeeded
|-
|"'''''7.4.3'''''" || Restore Failed
|-
|}

----
"'''7.5'''"

Restore a ZMatter Z-Wave dongle using a Z-Wave 500 Series dongle backup from an ISY-994

{|
|"'''''7.5.1'''''" || Restore Started
|-
|"'''''7.5.2'''''" || Restore Succeeded
|-
|"'''''7.5.3'''''" || Restore Failed
|-
|}

Polisy Developers:ZMatter:ZWave:Events

2022-11-20T16:04:05Z

Chris:

[[Polisy Developers]] : [[Polisy_Developers:ZMatter | ZMatter]] : [[Polisy_Developers:ZMatter:ZWave | Z-Wave]] : Events

All events sent by ZMatter Z-Wave are in the following format:

<Event seqnum="8" sid="uuid:27">
<control>'''_25'''</control>
<action>'''6.4'''</action>
<node/>
<eventInfo>
'''<info uid="34" curFrag="10" totalFrag="2128" reason="" wait="" />'''
</eventInfo>
</Event>

{|
|- style="vertical-align:top;"
|'''''control''''' || Always "'''_25'''" for ZMatter Z-Wave events
|- style="vertical-align:top;"
|'''''action''''' || The specific event (e.g. "'''2.3'''" for Exclude a Z-Wave device)
|- style="vertical-align:top;"
|'''''eventInfo''''' || Event specific XML
|-
|}

== Include/Exclude Status ==

"'''2.1'''"

Include/Exclude not active

----
"'''2.2'''"

Include a Z-Wave device

----
"'''2.3'''"

Exclude a Z-Wave device

----
"'''2.6'''"

Replace failed node (similar to Include a Z-Wave device)

== General Status ==

"'''3.7'''"

Controller is resetting

----

== General Error ==

"'''4.8'''"

Failed to replace a failed Z-Wave node

----
"'''4.9'''"

Failed to remove a failed Z-Wave node

----

== S2 Inclusion Events ==

"'''5.1'''"

No longer processing S2 Inclusion

----
"'''5.2'''"

Actively processing S2 Inclusion

----
"'''5.3'''"

'''<grant id="17" keymask="0x87" />'''

Requests the client to ask the user to specify the set of keys to grant the device.

{|
|- style="vertical-align:top;"
|'''''id''''' || Z-Wave Node ID of the device
|- style="vertical-align:top;"
|'''''keymask'''''
| A bitmask indicating the set of keys requested:
:: 0x80 - S0 Security
:: 0x01 - S2 Unauthenticated
:: 0x02 - S2 Authenticated
:: 0x04 - S2 Access
|-
|}

----
"'''5.4'''"

'''<verify id="17" key="51120-42991-08200-16940-32401-15092-37180-22568" />'''

Requests the client to ask the user to verify the given key matches the DSK on the device

{|
|'''''id''''' || Z-Wave Node ID of the device
|-
|'''''key''''' || The key to be verified
|-
|}

== OTA Firmware Upgrade ==

All OTA events receive the same event info format:

'''<info uid="34" curFrag="10" totalFrag="2128" reason="" wait="" />'''

Some of the values may be blank based on the type of OTA message sent.

{|
|- style="vertical-align:top;"
|'''''uid''''' || Z-Wave Node ID of the device
|- style="vertical-align:top;"
|'''''curFrag''''' || The current fragment being sent
|- style="vertical-align:top;"
|'''''totalFrag''''' || The total number of fragments
|- style="vertical-align:top;"
|'''''reason'''''
|
:: 254 - Manually restart the device
:: 255 - The device will automatically restart
|- style="vertical-align:top;"
|'''''wait''''' || The total number of seconds to wait before manually restarting the device (for reason 254)
|-
|}

----
"'''6.1'''"

'''<info uid="" curFrag="" totalFrag="" reason="" wait="" />'''

OTA processing is not active

----
"'''6.2'''"

'''<info uid="34" curFrag="" totalFrag="" reason="" wait="" />'''

Reading firmware file

----
"'''6.3'''"

'''<info uid="34" curFrag="" totalFrag="" reason="" wait="" />'''

OTA processing is upgrading device

----
"'''6.4'''"

'''<info uid="34" curFrag="10" totalFrag="2128" reason="" wait="" />'''

OTA fragment sent

----
"'''6.5'''"

'''<info uid="34" curFrag="2128" totalFrag="2128" reason="254" wait="120" />'''

OTA processing finished successfully

----
"'''6.6'''"

'''<info uid="34" curFrag="2128" totalFrag="2128" reason="" wait="" />'''

OTA processing failed

== Z-Wave Dongle Backup/Restore ==

"'''7.1'''"

'''<options><files zwave500Series="false" zmatter="true" /><dongle zwaveOther="false" zmatter="true" /></options>'''

Backup/Restore options have changed. This event is only sent if a Z-Wave dongle has been connected or disconnected.

----
"'''7.2'''"

Backup a ZMatter Z-Wave dongle

{|
|"'''''7.2.1'''''" || Backup Started
|-
|"'''''7.2.2'''''" || Backup Succeeded
|-
|"'''''7.2.3'''''" || Backup Failed
|-
|}

----
"'''7.3'''"

Backup a non-ZMatter Z-Wave dongle (700 Series)

{|
|"'''''7.3.1'''''" || Backup Started
|-
|"'''''7.3.2'''''" || Backup Succeeded
|-
|"'''''7.3.3'''''" || Backup Failed
|}

----
"'''7.4'''"

Restore a ZMatter Z-Wave dongle

{|
|"'''''7.4.1'''''" || Restore Started
|-
|"'''''7.4.2'''''" || Restore Succeeded
|-
|"'''''7.4.3'''''" || Restore Failed
|-
|}

----
"'''7.5'''"

Restore a ZMatter Z-Wave dongle using a Z-Wave 500 Series dongle backup from an ISY-994

{|
|"'''''7.5.1'''''" || Restore Started
|-
|"'''''7.5.2'''''" || Restore Succeeded
|-
|"'''''7.5.3'''''" || Restore Failed
|-
|}

Polisy Developers:ZMatter:ZWave:Events

2022-11-20T16:02:43Z

Chris: General Error/Status

[[Polisy Developers]] : [[Polisy_Developers:ZMatter | ZMatter]] : [[Polisy_Developers:ZMatter:ZWave | Z-Wave]] : Events

All events sent by ZMatter Z-Wave are in the following format:

<Event seqnum="8" sid="uuid:27">
<control>'''_25'''</control>
<action>'''6.4'''</action>
<node/>
<eventInfo>
'''<info uid="34" curFrag="10" totalFrag="2128" reason="" wait="" />'''
</eventInfo>
</Event>

{|
|- style="vertical-align:top;"
|'''''control''''' || Always "'''_25'''" for ZMatter Z-Wave events
|- style="vertical-align:top;"
|'''''action''''' || The specific event (e.g. "'''2.3'''" for Exclude a Z-Wave device)
|- style="vertical-align:top;"
|'''''eventInfo''''' || Event specific XML
|-
|}

== Include/Exclude Status ==

"'''2.1'''"

Include/Exclude not active

----
"'''2.2'''"

Include a Z-Wave device

----
"'''2.3'''"

Exclude a Z-Wave device

----
"'''2.6'''"

Replace failed node (similar to Include a Z-Wave device)

== General Status ==

"'''3.7'''"

Controller is resetting

----

== General Error ==

"'''4.8'''"

Failed to replace a failed Z-Wave node

----
"'''4.9'''"

Failed to remove a failed Z-Wave node

----

== S2 Inclusion Events ==

"'''5.1'''"

No longer processing S2 Inclusion

----
"'''5.2'''"

Actively processing S2 Inclusion

----
"'''5.3'''"

'''<grant id="17" keymask="0x87" />'''

Requests the client to ask the user to specify the set of keys to grant the device.

{|
|- style="vertical-align:top;"
|'''''id''''' || Z-Wave Node ID of the device
|- style="vertical-align:top;"
|'''''keymask'''''
| A bitmask indicating the set of keys requested:
:: 0x80 - S0 Security
:: 0x01 - S2 Unauthenticated
:: 0x02 - S2 Authenticated
:: 0x04 - S2 Access
|-
|}

----
"'''5.4'''"

'''<verify id="17" key="51120-42991-08200-16940-32401-15092-37180-22568" />'''

Requests the client to ask the user to verify the given key matches the DSK on the device

{|
|'''''id''''' || Z-Wave Node ID of the device
|-
|'''''key''''' || The key to be verified
|-
|}

== OTA Firmware Upgrade ==

All OTA events receive the same event info format:

'''<info uid="34" curFrag="10" totalFrag="2128" reason="" wait="" />'''

Some of the values may be blank based on the type of OTA message sent.

{|
|- style="vertical-align:top;"
|'''''uid''''' || Z-Wave Node ID of the device
|- style="vertical-align:top;"
|'''''curFrag''''' || The current fragment being sent
|- style="vertical-align:top;"
|'''''totalFrag''''' || The total number of fragments
|- style="vertical-align:top;"
|'''''reason'''''
|
:: 254 - Manually restart the device
:: 255 - The device will automatically restart
|- style="vertical-align:top;"
|'''''wait''''' || The total number of seconds to wait before manually restarting the device (for reason 254)
|-
|}

----
"'''6.1'''"

'''<info uid="" curFrag="" totalFrag="" reason="" wait="" />'''

OTA processing is not active

----
"'''6.2'''"

'''<info uid="34" curFrag="" totalFrag="" reason="" wait="" />'''

Reading firmware file

----
"'''6.3'''"

'''<info uid="34" curFrag="" totalFrag="" reason="" wait="" />'''

OTA processing is upgrading device

----
"'''6.4'''"

'''<info uid="34" curFrag="10" totalFrag="2128" reason="" wait="" />'''

OTA fragment sent

----
"'''6.5'''"

'''<info uid="34" curFrag="2128" totalFrag="2128" reason="254" wait="120" />'''

OTA processing finished successfully

----
"'''6.6'''"

'''<info uid="34" curFrag="2128" totalFrag="2128" reason="" wait="" />'''

OTA processing failed

== Z-Wave Dongle Backup/Restore ==

"'''7.1'''"

'''<options><files zwave500Series="false" zmatter="true" /><dongle zwaveOther="false" zmatter="true" /></options>'''

Backup/Restore options have changed. This event is only sent if a Z-Wave dongle has been connected or disconnected.

----
"'''7.2'''"

Backup a ZMatter Z-Wave dongle

{|
|"'''''7.2.1'''''" || Backup Started
|-
|"'''''7.2.2'''''" || Backup Succeeded
|-
|"'''''7.2.3'''''" || Backup Failed
|-
|}

----
"'''7.3'''"

Backup a non-ZMatter Z-Wave dongle (700 Series)

{|
|"'''''7.3.1'''''" || Backup Started
|-
|"'''''7.3.2'''''" || Backup Succeeded
|-
|"'''''7.3.3'''''" || Backup Failed
|}

----
"'''7.4'''"

Restore a ZMatter Z-Wave dongle

{|
|"'''''7.4.1'''''" || Restore Started
|-
|"'''''7.4.2'''''" || Restore Succeeded
|-
|"'''''7.4.3'''''" || Restore Failed
|-
|}

----
"'''7.5'''"

Restore a ZMatter Z-Wave dongle using a Z-Wave 500 Series dongle backup from an ISY-994

{|
|"'''''7.5.1'''''" || Restore Started
|-
|"'''''7.5.2'''''" || Restore Succeeded
|-
|"'''''7.5.3'''''" || Restore Failed
|-
|}

Polisy Developers:ZMatter:ZWave:REST

2022-11-17T20:57:06Z

Chris:

[[Polisy_Developers | Polisy Developers]] : [[Polisy_Developers:ZMatter | ZMatter]] : [[Polisy_Developers:ZMatter:ZWave | Z-Wave]] : REST

REST is a URL based command set that allows the developer to communicate with and
control Z-Wave services through ISY.

All REST commands use HTTP GET method.

Notes:
* URL Prefix: /rest/zmatter/zwave, e.g. ''http:<yourIsy>'''''/rest/zmatter/zwave'''''/node/exclude''

== SmartStart ==

/'''smartstart'''/'''add'''/''<dsk>''

Add a device ''DSK'' to the set of devices that are allowed to be added automatically with SmartStart.

{|
|'''''dsk''''' || The device DSK
|}

e.g.
{| style="font-family: courier;"
|/rest/zmatter/zwave/smartstart/add/51120-42991-08200-16940-32401-15092-37180-22568
|}

----
/'''smartstart'''/'''remove'''/''<dsk>''

Remove a device ''DSK'' from the set of devices that are allowed to be added automatically with SmartStart.

{|
|'''''dsk''''' || The device DSK
|}

e.g.
{| style="font-family: courier;"
|smartstart/remove/51120-42991-08200-16940-32401-15092-37180-22568
|}

== Include/Exclude ==

/'''node'''/'''include'''?'''power'''=''<boolean>''&'''nwi'''=''<boolean>''

Add a device to the Z-Wave network.
{|
|'''''power''''' || ''(Optional)'' '''true'''=High Power, false=Normal Power
|-
|'''''nwi''''' || ''(Optional)'' '''true'''=Use [[ISY_Develpers:API:V5:Z-Wave:Terms#Network_Wide_Inclusion | network wide inclusion]], false=Use standard inclusion
|-
|}

e.g.
{| style="font-family: courier;"
|/rest/zwave/node/include?power=false&nwi=true
|}

----
/'''node'''/'''exclude'''

Remove a device from the Z-Wave network.

e.g.
{| style="font-family: courier;"
|/rest/zwave/node/exclude
|}

----
/'''node'''/'''cancel'''

Cancel include/exclude/replication.

e.g.
{| style="font-family: courier;"
|/rest/zwave/node/cancel
|}

----
/'''node'''/''<nodeAddress>''/'''remove'''

Remove an unresponsive device from the Z-Wave network. If the device is responsive
then it will not be removed.

{|
|'''''nodeAddress''''' || ISY node address of device to be removed
|-
|}

e.g.
{| style="font-family: courier;"
|/rest/zwave/node/ZW010_1/remove
|}

== S2 Include/Exclude ==

/'''s2'''/'''device'''/''<id>''/'''keys'''/''<mask>''/'''grant'''[?'''pin'''=''<int>'']

Grant the keys based on those requested via a '''5.3''' event.

The set of granted keys are normally determined by asking the end user to choose zero or more keys within the subset of requested keys.

{|
|'''''id''''' || The Z-Wave Node ID for the device
|-
|'''''key''''' || The key mask
|-
|'''''pin''''' || Both ''S2 Authenticated'' and ''S2 Access'' require the device PIN which is normally the first 5 digits of the DSK for the device
|-
|}

e.g.
{| style="font-family: courier;"
|/rest/zmatter/zwave/s2/device/29/keys/0x07/grant?pin=21749
|}

----
/'''s2'''/'''device'''/''<id>''/'''publickey'''/''<key>''/'''reject''' 
/'''s2'''/'''device'''/''<id>''/'''publickey'''/''<key>''/'''verify'''

Reject or verify the DSK for the device based on the request sent via a '''5.4''' event.

The reject/verify is normally determined by asking the end user if it matches the DSK for the device.

{|
|'''''id''''' || The Z-Wave Node ID for the device
|-
|'''''key''''' || The DSK to compare with the actual DSK on the device
|-
|}

e.g.
{| style="font-family: courier;"
|/rest/zmatter/zwave/s2/device/29/publickey/51120-42991-08200-16940-32401-15092-37180-22568/verify
|}

== Z-Wave Network ==

/'''dongle'''/'''backup'''

Starts a backup of the Z-Wave network information on the ZMatter Z-Wave dongle to a file in IoP. Event '''7.2''' can be used to monitor the progress of the backup.

e.g.
{| style="font-family: courier;"
|/rest/zmatter/zwave/dongle/backup
|}

----
/'''dongle'''/'''restore'''

Starts a restore of the Z-Wave dongle using the network information stored in the backup file in IoP. Event '''7.4''' can be used to monitor the progress of the restore.

e.g.
{| style="font-family: courier;"
|/rest/zmatter/zwave/dongle/restore
|}

----
/'''sync'''?['''id'''=''<nodeAddress>''|''<zwaveNodeId>'']

Synchronize IoP with info on Z-Wave dongle for given device specified by either a Z-Wave node ID or an ISY node address. If ''id'' is not specified then sync all new & deleted devices.

{|
|'''''nodeAddress''''' || ''(Optional)'' An ISY node address (e.g. 'ZW005_1')
|-
|'''''zwaveNodeId''''' || ''(Optional)'' A Z-Wave node id (e.g. 5)
|-
|}

----
/'''node'''/''<nodeAddress>''/'''def'''/'''get'''

Returns the [[Polisy_Developers:ISY:API:Appendix:Node_Definitions | node definition]] for the specified node.

''Note: This is the only way to get node definitions for Z-Wave nodes, none of them are stored statically in node definition files.''

{|
|'''''nodeAddress''''' || The address of the node (e.g. 'ZW010_1'), or 0 for all Z-Wave nodes
|-
|}

e.g.
{| style="font-family: courier;"
|/rest/zwave/node/ZW010_1/def/get
|}

Polisy Developers:ZMatter:ZWave:REST

2022-11-17T19:28:17Z

Chris: ZMatter Z-Wave REST interface

[[Polisy_Developers | Polisy Developers]] : [[Polisy_Developers:ZMatter | ZMatter]] : [[Polisy_Developers:ZMatter:ZWave | Z-Wave]] : REST

REST is a URL based command set that allows the developer to communicate with and
control Z-Wave services through ISY.

All REST commands use HTTP GET method.

Notes:
* URL Prefix: /rest/zmatter/zwave, e.g. ''http:<yourIsy>'''''/rest/zmatter/zwave'''''/node/exclude''

== SmartStart ==

/'''smartstart'''/'''add'''/''<dsk>''

Add a device ''DSK'' to the set of devices that are allowed to be added automatically with SmartStart.

{|
|'''''dsk''''' || The device DSK
|}

e.g.
{| style="font-family: courier;"
|/rest/zmatter/zwave/smartstart/add/51120-42991-08200-16940-32401-15092-37180-22568
|}

----
/'''smartstart'''/'''remove'''/''<dsk>''

Remove a device ''DSK'' from the set of devices that are allowed to be added automatically with SmartStart.

{|
|'''''dsk''''' || The device DSK
|}

e.g.
{| style="font-family: courier;"
|smartstart/remove/51120-42991-08200-16940-32401-15092-37180-22568
|}

== Include/Exclude ==

/'''node'''/'''include'''?'''power'''=''<boolean>''&'''nwi'''=''<boolean>''

Add a device into the Z-Wave network.
{|
|'''''power''''' || ''(Optional)'' '''true'''=High Power, false=Normal Power
|-
|'''''nwi''''' || ''(Optional)'' '''true'''=Use [[ISY_Develpers:API:V5:Z-Wave:Terms#Network_Wide_Inclusion | network wide inclusion]], false=Use standard inclusion
|-
|}

e.g.
{| style="font-family: courier;"
|/rest/zwave/node/include?power=false&nwi=true
|}

----
/'''node'''/'''exclude'''

Remove a device from the Z-Wave network.

e.g.
{| style="font-family: courier;"
|/rest/zwave/node/exclude
|}

----
/'''node'''/'''cancel'''

Cancel include/exclude/replication.

e.g.
{| style="font-family: courier;"
|/rest/zwave/node/cancel
|}

----
/'''node'''/''<nodeAddress>''/'''remove'''

Remove an unresponsive device from the Z-Wave network. If the device is responsive
then it will not be removed.

{|
|'''''nodeAddress''''' || ISY node address of device to be removed
|-
|}

e.g.
{| style="font-family: courier;"
|/rest/zwave/node/ZW010_1/remove
|}

== S2 Include/Exclude ==

/'''s2'''/'''device'''/''<id>''/'''keys'''/''<mask>''/'''grant'''[?'''pin'''=''<int>'']

Grant the keys based on those requested via a '''5.3''' event.

The set of granted keys are normally determined by asking the end user to choose zero or more keys within the subset of requested keys.

{|
|'''''id''''' || The Z-Wave Node ID for the device
|-
|'''''key''''' || The key mask
|-
|'''''pin''''' || Both ''S2 Authenticated'' and ''S2 Access'' require the device PIN which is normally the first 5 digits of the DSK for the device
|-
|}

e.g.
{| style="font-family: courier;"
|/rest/zmatter/zwave/s2/device/29/keys/0x07/grant?pin=21749
|}

----
/'''s2'''/'''device'''/''<id>''/'''publickey'''/''<key>''/'''reject''' 
/'''s2'''/'''device'''/''<id>''/'''publickey'''/''<key>''/'''verify'''

Reject or verify the DSK for the device based on the request sent via a '''5.4''' event.

The reject/verify is normally determined by asking the end user if it matches the DSK for the device.

{|
|''''id''''' || The Z-Wave Node ID for the device
|-
|'''''key''''' || The DSK to compare with the actual DSK on the device
|-
|}

e.g.
{| style="font-family: courier;"
|/rest/zmatter/zwave/s2/device/29/publickey/51120-42991-08200-16940-32401-15092-37180-22568/grant?pin=2174
|}

== Z-Wave Network ==

/'''dongle'''/'''backup'''

Starts a backup of the Z-Wave network information on the ZMatter Z-Wave dongle to a file in IoP. Event '''7.2''' can be used to monitor the progress of the backup.

e.g.
{| style="font-family: courier;"
|/rest/zmatter/zwave/dongle/backup
|}

----
/'''dongle'''/'''restore'''

Starts a restore of the Z-Wave dongle using the network information stored in the backup file in IoP. Event '''7.4''' can be used to monitor the progress of the restore.

e.g.
{| style="font-family: courier;"
|/rest/zmatter/zwave/dongle/restore
|}

----
/'''sync'''?['''id'''=''<nodeAddress>''|''<zwaveNodeId>'']

Synchronize IoP with info on Z-Wave dongle for given device specified by either a Z-Wave node ID or an ISY node address. If ''id'' is not specified then sync all new & deleted devices.

{|
|'''''nodeAddress''''' || ''(Optional)'' An ISY node address (e.g. 'ZW005_1')
|-
|'''''zwaveNodeId''''' || ''(Optional)'' A Z-Wave node id (e.g. 5)
|-
|}

----
/'''node'''/''<nodeAddress>''/'''def'''/'''get'''

Returns the [[Polisy_Developers:ISY:API:Appendix:Node_Definitions | node definition]] for the specified node.

''Note: This is the only way to get node definitions for Z-Wave nodes, none of them are stored statically in node definition files.''

{|
|'''''nodeAddress''''' || The address of the node (e.g. 'ZW010_1'), or 0 for all Z-Wave nodes
|-
|}

e.g.
{| style="font-family: courier;"
|/rest/zwave/node/ZW010_1/def/get
|}

Polisy Developers:ZMatter:ZWave:Events

2022-11-17T19:25:13Z

Chris: Events generated by ZMatter Z-Wave

[[Polisy Developers]] : [[Polisy_Developers:ZMatter | ZMatter]] : [[Polisy_Developers:ZMatter:ZWave | Z-Wave]] : Events

All events sent by ZMatter Z-Wave are in the following format:

<Event seqnum="8" sid="uuid:27">
<control>'''_25'''</control>
<action>'''6.4'''</action>
<node/>
<eventInfo>
'''<info uid="34" curFrag="10" totalFrag="2128" reason="" wait="" />'''
</eventInfo>
</Event>

{|
|- style="vertical-align:top;"
|'''''control''''' || Always "'''_25'''" for ZMatter Z-Wave events
|- style="vertical-align:top;"
|'''''action''''' || The specific event (e.g. "'''2.3'''" for Exclude a Z-Wave device)
|- style="vertical-align:top;"
|'''''eventInfo''''' || Event specific XML
|-
|}

== Include/Exclude Status ==

"'''2.1'''"

Include/Exclude not active

----
"'''2.2'''"

Include a Z-Wave device

----
"'''2.3'''"

Exclude a Z-Wave device

----
"'''2.6'''"

Replace failed node

== S2 Inclusion Events ==

"'''5.1'''"

No longer processing S2 Inclusion

----
"'''5.2'''"

Actively processing S2 Inclusion

----
"'''5.3'''"

'''<grant id="17" keymask="0x87" />'''

Requests the client to ask the user to specify the set of keys to grant the device.

{|
|- style="vertical-align:top;"
|'''''id''''' || Z-Wave Node ID of the device
|- style="vertical-align:top;"
|'''''keymask'''''
| A bitmask indicating the set of keys requested:
:: 0x80 - S0 Security
:: 0x01 - S2 Unauthenticated
:: 0x02 - S2 Authenticated
:: 0x04 - S2 Access
|-
|}

----
"'''5.4'''"

'''<verify id="17" key="51120-42991-08200-16940-32401-15092-37180-22568" />'''

Requests the client to ask the user to verify the given key matches the DSK on the device

{|
|'''''id''''' || Z-Wave Node ID of the device
|-
|'''''key''''' || The key to be verified
|-
|}

== OTA Firmware Upgrade ==

All OTA events receive the same event info format:

'''<info uid="34" curFrag="10" totalFrag="2128" reason="" wait="" />'''

Some of the values may be blank based on the type of OTA messag sent.

{|
|- style="vertical-align:top;"
|'''''uid''''' || Z-Wave Node ID of the device
|- style="vertical-align:top;"
|'''''curFrag''''' || The current fragment being sent
|- style="vertical-align:top;"
|'''''totalFrag''''' || The total number of fragments
|- style="vertical-align:top;"
|'''''reason'''''
|
:: 254 - Manually restart the device
:: 255 - The device will automatically restart
|- style="vertical-align:top;"
|'''''wait''''' || The total number of seconds to wait before manually restarting the device (for reason 254)
|-
|}

----
"'''6.1'''"

'''<info uid="" curFrag="" totalFrag="" reason="" wait="" />'''

OTA processing is not active

----
"'''6.2'''"

'''<info uid="34" curFrag="" totalFrag="" reason="" wait="" />'''

Reading firmware file

----
"'''6.3'''"

'''<info uid="34" curFrag="" totalFrag="" reason="" wait="" />'''

OTA processing is upgrading device

----
"'''6.4'''"

'''<info uid="34" curFrag="10" totalFrag="2128" reason="" wait="" />'''

OTA fragment sent

----
"'''6.5'''"

'''<info uid="34" curFrag="2128" totalFrag="2128" reason="254" wait="120" />'''

OTA processing finished successfully

----
"'''6.6'''"

'''<info uid="34" curFrag="2128" totalFrag="2128" reason="" wait="" />'''

OTA processing failed

== Z-Wave Dongle Backup/Restore ==

"'''7.1'''"

'''<options><files zwave500Series="false" zmatter="true" /><dongle zwaveOther="false" zmatter="true" /></options>'''

Backup/Restore options have change. This event is only sent if a Z-Wave dongle has been connected or disconnected.

----
"'''7.2'''"

Backup a ZMatter Z-Wave dongle

{|
|"'''''7.2.1'''''" || Backup Started
|-
|"'''''7.2.2'''''" || Backup Succeeded
|-
|"'''''7.2.3'''''" || Backup Failed
|-
|}

----
"'''7.3'''"

Backup a non-ZMatter Z-Wave dongle (700 Series)

{|
|"'''''7.3.1'''''" || Backup Started
|-
|"'''''7.3.2'''''" || Backup Succeeded
|-
|"'''''7.3.3'''''" || Backup Failed
|}

----
"'''7.4'''"

Restore a ZMatter Z-Wave dongle

{|
|"'''''7.4.1'''''" || Restore Started
|-
|"'''''7.4.2'''''" || Restore Succeeded
|-
|"'''''7.4.3'''''" || Restore Failed
|-
|}

----
"'''7.5'''"

Restore a ZMatter Z-Wave dongle using a Z-Wave 500 Series dongle backup from an ISY-994

{|
|"'''''7.5.1'''''" || Restore Started
|-
|"'''''7.5.2'''''" || Restore Succeeded
|-
|"'''''7.5.3'''''" || Restore Failed
|-
|}

ISY-994i Series:EMail and Networking Substitution Variables

2022-04-11T16:51:34Z

Chris: Clarify .uom.id

==Note==
In case of email customized content, Both the '''Subject''' and the '''Body'''' must be non empty 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

====Formatting Tags====
''(available in Polisy 5.4.1)''

An optional tag may be appended to the variable name indicating how the resulting text should be formatted.

{| style="color: black; background-color: #ffffcc;" width="95%" class="wikitable"
!align="left"| Tag Name
!align="left"| Example
!align="left"| Type
!align="left"| Description
|-
| ''':url''' || ${sys.node.#.name:url} || URL encoded || e.g. "Hello World" becomes "Hello%20World"
|-
| ''':std''' || ${sys.node.#.name:std} || Standard formatting || Formats with no conversion
|-
| no tag || ${sys.node.#.name} || Default formatting || Currently the same as ''':std'''
|-
|}

Note: If you are using a ''Formatting Tag'' then it is always apecified at the end. e.g. ${sys.node.#.ST.raw:url}

====System Variables ====
{| style="color: black; background-color: #ffffcc;" width="95%" class="wikitable"
!align="left"| Value Name
!align="left"| 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 ====
{| style="color: black; background-color: #ffffcc;" width="95%" class="wikitable"
!align="left"| Value Name
!align="left"| 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>

A formatted representation of a value is normally used when substituting a device status variable (e.g. "100%" for a dimmer), but there is an option to choose a different form of the value by adding an extension to the name.

{| style="color: black; background-color: #ffffcc;" width="95%" class="wikitable"
!align="left"| Extension
!align="left"| Example
!align="left"| Type
!align="left"| Description
|-
| '''.raw''' || ${sys.node.#.ST.raw} || Raw Value || Shows the raw value rather than the formatted value e.g. for an Insteon dimmer status show "255" instead of "100%"
|-
| '''.uom.id''' || ${sys.node.#.ST.uom.id} || Unit of Measure || Shows the numeric unit of measure of the raw value rather than the value itself e.g. for the current temperature show "17" (fahrenheit)
|-
| not specified || ${sys.node.#.ST} || Default formatting || Shows the formatted value e.g. for an Insteon dimmer status show "100%" instead of "255"
|-
|}

{| style="color: black; background-color: #ffffcc;" width="95%" class="wikitable"
!align="left"| Variable
!align="left"| Example
!align="left"| 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>''.ADRPST || sys.node.11 22 AA 1.ADRPST || Auto DR Processing State
|-
| sys.node.''<address>''.AIRFLOW || sys.node.11 22 AA 1.AIRFLOW || Air Flow
|-
| sys.node.''<address>''.ALARM || sys.node.11 22 AA 1.ALARM || An alarm occurred
|-
| sys.node.''<address>''.ANGLPOS || sys.node.11 22 AA 1.ANGLPOS || Angle Position
|-
| sys.node.''<address>''.ATMPRES || sys.node.11 22 AA 1.ATMPRES || Atmospheric Pressure
|-
| sys.node.''<address>''.AWAKE || sys.node.11 22 AA 1.AWAKE || Awake
|-
| sys.node.''<address>''.BARPRES || sys.node.11 22 AA 1.BARPRES || Barometric Pressure
|-
| sys.node.''<address>''.BATLVL || sys.node.11 22 AA 1.BATLVL || Battery level
|-
| sys.node.''<address>''.BEEP || sys.node.11 22 AA 1.BEEP || Beep
|-
| sys.node.''<address>''.BMAN || sys.node.11 22 AA 1.BMAN || Deprecated - Use FDUP or FDDOWN
|-
| sys.node.''<address>''.BRT || sys.node.11 22 AA 1.BRT || Brighten
|-
| sys.node.''<address>''.BUSY || sys.node.11 22 AA 1.BUSY || Device is Busy
|-
| sys.node.''<address>''.CC || sys.node.11 22 AA 1.CC || Current Current
|-
| sys.node.''<address>''.CLIEMD || sys.node.11 22 AA 1.CLIEMD || Energy Mode
|-
| sys.node.''<address>''.CLIFRS || sys.node.11 22 AA 1.CLIFRS || Fan Running State
|-
| sys.node.''<address>''.CLIFS || sys.node.11 22 AA 1.CLIFS || Fan Setting
|-
| sys.node.''<address>''.CLIFSO || sys.node.11 22 AA 1.CLIFSO || Fan Setting Override
|-
| sys.node.''<address>''.CLIHCS || sys.node.11 22 AA 1.CLIHCS || Heat/Cool State
|-
| sys.node.''<address>''.CLIHUM || sys.node.11 22 AA 1.CLIHUM || Humidity
|-
| sys.node.''<address>''.CLIMD || sys.node.11 22 AA 1.CLIMD || Thermostat Mode
|-
| sys.node.''<address>''.CLISMD || sys.node.11 22 AA 1.CLISMD || Schedule Mode
|-
| sys.node.''<address>''.CLISPC || sys.node.11 22 AA 1.CLISPC || Cool Setpoint
|-
| sys.node.''<address>''.CLISPH || sys.node.11 22 AA 1.CLISPH || Heat Setpoint
|-
| sys.node.''<address>''.CLITEMP || sys.node.11 22 AA 1.CLITEMP || Current Temperature
|-
| sys.node.''<address>''.CO2LVL || sys.node.11 22 AA 1.CO2LVL || CO2 Level
|-
| sys.node.''<address>''.CPW || sys.node.11 22 AA 1.CPW || Current Power Used
|-
| sys.node.''<address>''.CTL || sys.node.11 22 AA 1.CTL || Controller Action
|-
| sys.node.''<address>''.CV || sys.node.11 22 AA 1.CV || Current Voltage
|-
| sys.node.''<address>''.DELAY || sys.node.11 22 AA 1.DELAY || Delay
|-
| sys.node.''<address>''.DEWPT || sys.node.11 22 AA 1.DEWPT || Dew Point
|-
| sys.node.''<address>''.DFOF || sys.node.11 22 AA 1.DFOF || Fast Off
|-
| sys.node.''<address>''.DFON || sys.node.11 22 AA 1.DFON || Fast On
|-
| sys.node.''<address>''.DIM || sys.node.11 22 AA 1.DIM || Dim
|-
| sys.node.''<address>''.DISTANC || sys.node.11 22 AA 1.DISTANC || Distance
|-
| sys.node.''<address>''.DOF || sys.node.11 22 AA 1.DOF || Off
|-
| sys.node.''<address>''.DOF3 || sys.node.11 22 AA 1.DOF3 || Off 3 Key Presses
|-
| sys.node.''<address>''.DOF4 || sys.node.11 22 AA 1.DOF4 || Off 4 Key Presses
|-
| sys.node.''<address>''.DOF5 || sys.node.11 22 AA 1.DOF5 || Off 5 Key Presses
|-
| sys.node.''<address>''.DON || sys.node.11 22 AA 1.DON || On
|-
| sys.node.''<address>''.DON3 || sys.node.11 22 AA 1.DON3 || On 3 Key Presses
|-
| sys.node.''<address>''.DON4 || sys.node.11 22 AA 1.DON4 || On 4 Key Presses
|-
| sys.node.''<address>''.DON5 || sys.node.11 22 AA 1.DON5 || On 5 Key Presses
|-
| sys.node.''<address>''.DUR || sys.node.11 22 AA 1.DUR || Duration
|-
| sys.node.''<address>''.ELECCON || sys.node.11 22 AA 1.ELECCON || Electrical Conductivity
|-
| sys.node.''<address>''.ELECRES || sys.node.11 22 AA 1.ELECRES || Electrical Resistivity
|-
| sys.node.''<address>''.ERR || sys.node.11 22 AA 1.ERR || Error
|-
| sys.node.''<address>''.FDDOWN || sys.node.11 22 AA 1.FDDOWN || Fade Down
|-
| sys.node.''<address>''.FDSTOP || sys.node.11 22 AA 1.FDSTOP || Fade Stop
|-
| sys.node.''<address>''.FDUP || sys.node.11 22 AA 1.FDUP || Fade Up
|-
| sys.node.''<address>''.GPV || sys.node.11 22 AA 1.GPV || General Purpose Value
|-
| sys.node.''<address>''.GVOL || sys.node.11 22 AA 1.GVOL || Water Volume
|-
| sys.node.''<address>''.HAIL || sys.node.11 22 AA 1.HAIL || Hail
|-
| sys.node.''<address>''.LUMIN || sys.node.11 22 AA 1.LUMIN || Luminance
|-
| sys.node.''<address>''.MODE || sys.node.11 22 AA 1.MODE || Mode
|-
| sys.node.''<address>''.MOIST || sys.node.11 22 AA 1.MOIST || Moisture
|-
| sys.node.''<address>''.OL || sys.node.11 22 AA 1.OL || On Level
|-
| sys.node.''<address>''.PF || sys.node.11 22 AA 1.PF || Power Factor
|-
| sys.node.''<address>''.PPW || sys.node.11 22 AA 1.PPW || Polarized Power Used
|-
| sys.node.''<address>''.PULSCNT || sys.node.11 22 AA 1.PULSCNT || Pulse Count
|-
| sys.node.''<address>''.QUERY || sys.node.11 22 AA 1.QUERY || Query Device
|-
| sys.node.''<address>''.RAINRT || sys.node.11 22 AA 1.RAINRT || Rain Rate
|-
| sys.node.''<address>''.RESET || sys.node.11 22 AA 1.RESET || Reset values
|-
| sys.node.''<address>''.ROTATE || sys.node.11 22 AA 1.ROTATE || Rotation
|-
| sys.node.''<address>''.RR || sys.node.11 22 AA 1.RR || Ramp Rate
|-
| sys.node.''<address>''.SECMD || sys.node.11 22 AA 1.SECMD || Device secure mode
|-
| sys.node.''<address>''.SEISINT || sys.node.11 22 AA 1.SEISINT || Seismic Intensity
|-
| sys.node.''<address>''.SEISMAG || sys.node.11 22 AA 1.SEISMAG || Seismic Magnitude
|-
| sys.node.''<address>''.SMAN || sys.node.11 22 AA 1.SMAN || Deprecated - Use FDSTOP
|-
| sys.node.''<address>''.SOILT || sys.node.11 22 AA 1.SOILT || Soil Temperature
|-
| sys.node.''<address>''.SOLRAD || sys.node.11 22 AA 1.SOLRAD || Solar Radiation
|-
| sys.node.''<address>''.SPEED || sys.node.11 22 AA 1.SPEED || Velocity
|-
| sys.node.''<address>''.ST || sys.node.11 22 AA 1.ST || Status
|-
| sys.node.''<address>''.SVOL || sys.node.11 22 AA 1.SVOL || Sound Volume
|-
| sys.node.''<address>''.TANKCAP || sys.node.11 22 AA 1.TANKCAP || Tank Capacity
|-
| sys.node.''<address>''.TIDELVL || sys.node.11 22 AA 1.TIDELVL || Tide Level
|-
| sys.node.''<address>''.TIMEREM || sys.node.11 22 AA 1.TIMEREM || Time remaining
|-
| sys.node.''<address>''.TPW || sys.node.11 22 AA 1.TPW || Total Energy Used
|-
| sys.node.''<address>''.UAC || sys.node.11 22 AA 1.UAC || Valid user access code entered
|-
| sys.node.''<address>''.UOM || sys.node.11 22 AA 1.UOM || Unit
|-
| sys.node.''<address>''.USRNUM || sys.node.11 22 AA 1.USRNUM || User access code
|-
| sys.node.''<address>''.UV || sys.node.11 22 AA 1.UV || Ultraviolet
|-
| sys.node.''<address>''.VOCLVL || sys.node.11 22 AA 1.VOCLVL || Volatile Organic Compound (VOC) level
|-
| sys.node.''<address>''.WATERT || sys.node.11 22 AA 1.WATERT || Water Temperature
|-
| sys.node.''<address>''.WEIGHT || sys.node.11 22 AA 1.WEIGHT || Weight
|-
| sys.node.''<address>''.WINDDIR || sys.node.11 22 AA 1.WINDDIR || Wind Direction
|-
| sys.node.''<address>''.WVOL || sys.node.11 22 AA 1.WVOL || Water Volume
|-
| sys.node.''<address>''.GV0 || sys.node.11 22 AA 1.GV0 || Custom Control 0
|-
| sys.node.''<address>''.GV1 || sys.node.11 22 AA 1.GV1 || Custom Control 1
|-
| sys.node.''<address>''.GV2 || sys.node.11 22 AA 1.GV2 || Custom Control 2
|-
| sys.node.''<address>''.GV3 || sys.node.11 22 AA 1.GV3 || Custom Control 3
|-
| sys.node.''<address>''.GV4 || sys.node.11 22 AA 1.GV4 || Custom Control 4
|-
| sys.node.''<address>''.GV5 || sys.node.11 22 AA 1.GV5 || Custom Control 5
|-
| sys.node.''<address>''.GV6 || sys.node.11 22 AA 1.GV6 || Custom Control 6
|-
| sys.node.''<address>''.GV7 || sys.node.11 22 AA 1.GV7 || Custom Control 7
|-
| sys.node.''<address>''.GV8 || sys.node.11 22 AA 1.GV8 || Custom Control 8
|-
| sys.node.''<address>''.GV9 || sys.node.11 22 AA 1.GV9 || Custom Control 9
|-
| sys.node.''<address>''.GV10 || sys.node.11 22 AA 1.GV10 || Custom Control 10
|-
| sys.node.''<address>''.GV11 || sys.node.11 22 AA 1.GV11 || Custom Control 11
|-
| sys.node.''<address>''.GV12 || sys.node.11 22 AA 1.GV12 || Custom Control 12
|-
| sys.node.''<address>''.GV13 || sys.node.11 22 AA 1.GV13 || Custom Control 13
|-
| sys.node.''<address>''.GV14 || sys.node.11 22 AA 1.GV14 || Custom Control 14
|-
| sys.node.''<address>''.GV15 || sys.node.11 22 AA 1.GV15 || Custom Control 15
|-
| sys.node.''<address>''.GV16 || sys.node.11 22 AA 1.GV16 || Custom Control 16
|-
| sys.node.''<address>''.GV17 || sys.node.11 22 AA 1.GV17 || Custom Control 17
|-
| sys.node.''<address>''.GV18 || sys.node.11 22 AA 1.GV18 || Custom Control 18
|-
| sys.node.''<address>''.GV19 || sys.node.11 22 AA 1.GV19 || Custom Control 19
|-
| sys.node.''<address>''.GV20 || sys.node.11 22 AA 1.GV20 || Custom Control 20
|-
|}

====Elk Variables====
{| style="color: black; background-color: #ffffcc;" width="95%" class="wikitable"
!align="left"| Variable
!align="left"| Example
!align="left"| Description
|-
| elk.area.''<areaNumber>''.name || elk.area.1.name || Name of the Area
|-
| elk.area.''<areaNumber>''.armedState || elk.area.1.armedState || Area Armed State
|-
| elk.area.''<areaNumber>''.armUpState || elk.area.1.armUpState || Area Arm Up State
|-
| elk.area.''<areaNumber>''.alarmState || elk.area.1.alarmState || 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====
{| style="color: black; background-color: #ffffcc;" width="95%" class="wikitable"
!align="left"| Variable
!align="left"| Example
!align="left"| 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

ISY-994i Series:EMail and Networking Substitution Variables

2022-04-11T16:40:59Z

Chris: Description of .raw and .uom.id

==Note==
In case of email customized content, Both the '''Subject''' and the '''Body'''' must be non empty 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

====Formatting Tags====
''(available in Polisy 5.4.1)''

An optional tag may be appended to the variable name indicating how the resulting text should be formatted.

{| style="color: black; background-color: #ffffcc;" width="95%" class="wikitable"
!align="left"| Tag Name
!align="left"| Example
!align="left"| Type
!align="left"| Description
|-
| ''':url''' || ${sys.node.#.name:url} || URL encoded || e.g. "Hello World" becomes "Hello%20World"
|-
| ''':std''' || ${sys.node.#.name:std} || Standard formatting || Formats with no conversion
|-
| no tag || ${sys.node.#.name} || Default formatting || Currently the same as ''':std'''
|-
|}

Note: If you are using a ''Formatting Tag'' then it is always apecified at the end. e.g. ${sys.node.#.ST.raw:url}

====System Variables ====
{| style="color: black; background-color: #ffffcc;" width="95%" class="wikitable"
!align="left"| Value Name
!align="left"| 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 ====
{| style="color: black; background-color: #ffffcc;" width="95%" class="wikitable"
!align="left"| Value Name
!align="left"| 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>

A formatted representation of a value is normally used when substituting a device status variable (e.g. "100%" for a dimmer), but there is an option to choose a different form of the value by adding an extension to the name.

{| style="color: black; background-color: #ffffcc;" width="95%" class="wikitable"
!align="left"| Extension
!align="left"| Example
!align="left"| Type
!align="left"| Description
|-
| '''.raw''' || ${sys.node.#.ST.raw} || Raw Value || Shows the raw value rather than the formatted value e.g. for an Insteon dimmer status show "255" instead of "100%"
|-
| '''.uom.id''' || ${sys.node.#.ST.uom.id} || Unit of Measure || Shows the numeric unit of measure of the value rather than the value itself e.g. for an Insteon dimmer status show "51" (percent)
|-
| not specified || ${sys.node.#.ST} || Default formatting || Shows the formatted value e.g. for an Insteon dimmer status show "100%" instead of "255"
|-
|}

{| style="color: black; background-color: #ffffcc;" width="95%" class="wikitable"
!align="left"| Variable
!align="left"| Example
!align="left"| 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>''.ADRPST || sys.node.11 22 AA 1.ADRPST || Auto DR Processing State
|-
| sys.node.''<address>''.AIRFLOW || sys.node.11 22 AA 1.AIRFLOW || Air Flow
|-
| sys.node.''<address>''.ALARM || sys.node.11 22 AA 1.ALARM || An alarm occurred
|-
| sys.node.''<address>''.ANGLPOS || sys.node.11 22 AA 1.ANGLPOS || Angle Position
|-
| sys.node.''<address>''.ATMPRES || sys.node.11 22 AA 1.ATMPRES || Atmospheric Pressure
|-
| sys.node.''<address>''.AWAKE || sys.node.11 22 AA 1.AWAKE || Awake
|-
| sys.node.''<address>''.BARPRES || sys.node.11 22 AA 1.BARPRES || Barometric Pressure
|-
| sys.node.''<address>''.BATLVL || sys.node.11 22 AA 1.BATLVL || Battery level
|-
| sys.node.''<address>''.BEEP || sys.node.11 22 AA 1.BEEP || Beep
|-
| sys.node.''<address>''.BMAN || sys.node.11 22 AA 1.BMAN || Deprecated - Use FDUP or FDDOWN
|-
| sys.node.''<address>''.BRT || sys.node.11 22 AA 1.BRT || Brighten
|-
| sys.node.''<address>''.BUSY || sys.node.11 22 AA 1.BUSY || Device is Busy
|-
| sys.node.''<address>''.CC || sys.node.11 22 AA 1.CC || Current Current
|-
| sys.node.''<address>''.CLIEMD || sys.node.11 22 AA 1.CLIEMD || Energy Mode
|-
| sys.node.''<address>''.CLIFRS || sys.node.11 22 AA 1.CLIFRS || Fan Running State
|-
| sys.node.''<address>''.CLIFS || sys.node.11 22 AA 1.CLIFS || Fan Setting
|-
| sys.node.''<address>''.CLIFSO || sys.node.11 22 AA 1.CLIFSO || Fan Setting Override
|-
| sys.node.''<address>''.CLIHCS || sys.node.11 22 AA 1.CLIHCS || Heat/Cool State
|-
| sys.node.''<address>''.CLIHUM || sys.node.11 22 AA 1.CLIHUM || Humidity
|-
| sys.node.''<address>''.CLIMD || sys.node.11 22 AA 1.CLIMD || Thermostat Mode
|-
| sys.node.''<address>''.CLISMD || sys.node.11 22 AA 1.CLISMD || Schedule Mode
|-
| sys.node.''<address>''.CLISPC || sys.node.11 22 AA 1.CLISPC || Cool Setpoint
|-
| sys.node.''<address>''.CLISPH || sys.node.11 22 AA 1.CLISPH || Heat Setpoint
|-
| sys.node.''<address>''.CLITEMP || sys.node.11 22 AA 1.CLITEMP || Current Temperature
|-
| sys.node.''<address>''.CO2LVL || sys.node.11 22 AA 1.CO2LVL || CO2 Level
|-
| sys.node.''<address>''.CPW || sys.node.11 22 AA 1.CPW || Current Power Used
|-
| sys.node.''<address>''.CTL || sys.node.11 22 AA 1.CTL || Controller Action
|-
| sys.node.''<address>''.CV || sys.node.11 22 AA 1.CV || Current Voltage
|-
| sys.node.''<address>''.DELAY || sys.node.11 22 AA 1.DELAY || Delay
|-
| sys.node.''<address>''.DEWPT || sys.node.11 22 AA 1.DEWPT || Dew Point
|-
| sys.node.''<address>''.DFOF || sys.node.11 22 AA 1.DFOF || Fast Off
|-
| sys.node.''<address>''.DFON || sys.node.11 22 AA 1.DFON || Fast On
|-
| sys.node.''<address>''.DIM || sys.node.11 22 AA 1.DIM || Dim
|-
| sys.node.''<address>''.DISTANC || sys.node.11 22 AA 1.DISTANC || Distance
|-
| sys.node.''<address>''.DOF || sys.node.11 22 AA 1.DOF || Off
|-
| sys.node.''<address>''.DOF3 || sys.node.11 22 AA 1.DOF3 || Off 3 Key Presses
|-
| sys.node.''<address>''.DOF4 || sys.node.11 22 AA 1.DOF4 || Off 4 Key Presses
|-
| sys.node.''<address>''.DOF5 || sys.node.11 22 AA 1.DOF5 || Off 5 Key Presses
|-
| sys.node.''<address>''.DON || sys.node.11 22 AA 1.DON || On
|-
| sys.node.''<address>''.DON3 || sys.node.11 22 AA 1.DON3 || On 3 Key Presses
|-
| sys.node.''<address>''.DON4 || sys.node.11 22 AA 1.DON4 || On 4 Key Presses
|-
| sys.node.''<address>''.DON5 || sys.node.11 22 AA 1.DON5 || On 5 Key Presses
|-
| sys.node.''<address>''.DUR || sys.node.11 22 AA 1.DUR || Duration
|-
| sys.node.''<address>''.ELECCON || sys.node.11 22 AA 1.ELECCON || Electrical Conductivity
|-
| sys.node.''<address>''.ELECRES || sys.node.11 22 AA 1.ELECRES || Electrical Resistivity
|-
| sys.node.''<address>''.ERR || sys.node.11 22 AA 1.ERR || Error
|-
| sys.node.''<address>''.FDDOWN || sys.node.11 22 AA 1.FDDOWN || Fade Down
|-
| sys.node.''<address>''.FDSTOP || sys.node.11 22 AA 1.FDSTOP || Fade Stop
|-
| sys.node.''<address>''.FDUP || sys.node.11 22 AA 1.FDUP || Fade Up
|-
| sys.node.''<address>''.GPV || sys.node.11 22 AA 1.GPV || General Purpose Value
|-
| sys.node.''<address>''.GVOL || sys.node.11 22 AA 1.GVOL || Water Volume
|-
| sys.node.''<address>''.HAIL || sys.node.11 22 AA 1.HAIL || Hail
|-
| sys.node.''<address>''.LUMIN || sys.node.11 22 AA 1.LUMIN || Luminance
|-
| sys.node.''<address>''.MODE || sys.node.11 22 AA 1.MODE || Mode
|-
| sys.node.''<address>''.MOIST || sys.node.11 22 AA 1.MOIST || Moisture
|-
| sys.node.''<address>''.OL || sys.node.11 22 AA 1.OL || On Level
|-
| sys.node.''<address>''.PF || sys.node.11 22 AA 1.PF || Power Factor
|-
| sys.node.''<address>''.PPW || sys.node.11 22 AA 1.PPW || Polarized Power Used
|-
| sys.node.''<address>''.PULSCNT || sys.node.11 22 AA 1.PULSCNT || Pulse Count
|-
| sys.node.''<address>''.QUERY || sys.node.11 22 AA 1.QUERY || Query Device
|-
| sys.node.''<address>''.RAINRT || sys.node.11 22 AA 1.RAINRT || Rain Rate
|-
| sys.node.''<address>''.RESET || sys.node.11 22 AA 1.RESET || Reset values
|-
| sys.node.''<address>''.ROTATE || sys.node.11 22 AA 1.ROTATE || Rotation
|-
| sys.node.''<address>''.RR || sys.node.11 22 AA 1.RR || Ramp Rate
|-
| sys.node.''<address>''.SECMD || sys.node.11 22 AA 1.SECMD || Device secure mode
|-
| sys.node.''<address>''.SEISINT || sys.node.11 22 AA 1.SEISINT || Seismic Intensity
|-
| sys.node.''<address>''.SEISMAG || sys.node.11 22 AA 1.SEISMAG || Seismic Magnitude
|-
| sys.node.''<address>''.SMAN || sys.node.11 22 AA 1.SMAN || Deprecated - Use FDSTOP
|-
| sys.node.''<address>''.SOILT || sys.node.11 22 AA 1.SOILT || Soil Temperature
|-
| sys.node.''<address>''.SOLRAD || sys.node.11 22 AA 1.SOLRAD || Solar Radiation
|-
| sys.node.''<address>''.SPEED || sys.node.11 22 AA 1.SPEED || Velocity
|-
| sys.node.''<address>''.ST || sys.node.11 22 AA 1.ST || Status
|-
| sys.node.''<address>''.SVOL || sys.node.11 22 AA 1.SVOL || Sound Volume
|-
| sys.node.''<address>''.TANKCAP || sys.node.11 22 AA 1.TANKCAP || Tank Capacity
|-
| sys.node.''<address>''.TIDELVL || sys.node.11 22 AA 1.TIDELVL || Tide Level
|-
| sys.node.''<address>''.TIMEREM || sys.node.11 22 AA 1.TIMEREM || Time remaining
|-
| sys.node.''<address>''.TPW || sys.node.11 22 AA 1.TPW || Total Energy Used
|-
| sys.node.''<address>''.UAC || sys.node.11 22 AA 1.UAC || Valid user access code entered
|-
| sys.node.''<address>''.UOM || sys.node.11 22 AA 1.UOM || Unit
|-
| sys.node.''<address>''.USRNUM || sys.node.11 22 AA 1.USRNUM || User access code
|-
| sys.node.''<address>''.UV || sys.node.11 22 AA 1.UV || Ultraviolet
|-
| sys.node.''<address>''.VOCLVL || sys.node.11 22 AA 1.VOCLVL || Volatile Organic Compound (VOC) level
|-
| sys.node.''<address>''.WATERT || sys.node.11 22 AA 1.WATERT || Water Temperature
|-
| sys.node.''<address>''.WEIGHT || sys.node.11 22 AA 1.WEIGHT || Weight
|-
| sys.node.''<address>''.WINDDIR || sys.node.11 22 AA 1.WINDDIR || Wind Direction
|-
| sys.node.''<address>''.WVOL || sys.node.11 22 AA 1.WVOL || Water Volume
|-
| sys.node.''<address>''.GV0 || sys.node.11 22 AA 1.GV0 || Custom Control 0
|-
| sys.node.''<address>''.GV1 || sys.node.11 22 AA 1.GV1 || Custom Control 1
|-
| sys.node.''<address>''.GV2 || sys.node.11 22 AA 1.GV2 || Custom Control 2
|-
| sys.node.''<address>''.GV3 || sys.node.11 22 AA 1.GV3 || Custom Control 3
|-
| sys.node.''<address>''.GV4 || sys.node.11 22 AA 1.GV4 || Custom Control 4
|-
| sys.node.''<address>''.GV5 || sys.node.11 22 AA 1.GV5 || Custom Control 5
|-
| sys.node.''<address>''.GV6 || sys.node.11 22 AA 1.GV6 || Custom Control 6
|-
| sys.node.''<address>''.GV7 || sys.node.11 22 AA 1.GV7 || Custom Control 7
|-
| sys.node.''<address>''.GV8 || sys.node.11 22 AA 1.GV8 || Custom Control 8
|-
| sys.node.''<address>''.GV9 || sys.node.11 22 AA 1.GV9 || Custom Control 9
|-
| sys.node.''<address>''.GV10 || sys.node.11 22 AA 1.GV10 || Custom Control 10
|-
| sys.node.''<address>''.GV11 || sys.node.11 22 AA 1.GV11 || Custom Control 11
|-
| sys.node.''<address>''.GV12 || sys.node.11 22 AA 1.GV12 || Custom Control 12
|-
| sys.node.''<address>''.GV13 || sys.node.11 22 AA 1.GV13 || Custom Control 13
|-
| sys.node.''<address>''.GV14 || sys.node.11 22 AA 1.GV14 || Custom Control 14
|-
| sys.node.''<address>''.GV15 || sys.node.11 22 AA 1.GV15 || Custom Control 15
|-
| sys.node.''<address>''.GV16 || sys.node.11 22 AA 1.GV16 || Custom Control 16
|-
| sys.node.''<address>''.GV17 || sys.node.11 22 AA 1.GV17 || Custom Control 17
|-
| sys.node.''<address>''.GV18 || sys.node.11 22 AA 1.GV18 || Custom Control 18
|-
| sys.node.''<address>''.GV19 || sys.node.11 22 AA 1.GV19 || Custom Control 19
|-
| sys.node.''<address>''.GV20 || sys.node.11 22 AA 1.GV20 || Custom Control 20
|-
|}

====Elk Variables====
{| style="color: black; background-color: #ffffcc;" width="95%" class="wikitable"
!align="left"| Variable
!align="left"| Example
!align="left"| Description
|-
| elk.area.''<areaNumber>''.name || elk.area.1.name || Name of the Area
|-
| elk.area.''<areaNumber>''.armedState || elk.area.1.armedState || Area Armed State
|-
| elk.area.''<areaNumber>''.armUpState || elk.area.1.armUpState || Area Arm Up State
|-
| elk.area.''<areaNumber>''.alarmState || elk.area.1.alarmState || 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====
{| style="color: black; background-color: #ffffcc;" width="95%" class="wikitable"
!align="left"| Variable
!align="left"| Example
!align="left"| 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

Polisy Developers:ISY:API:Node Server:REST Support in ISY

2022-04-08T03:45:07Z

Chris: Fix REST Return Codes link

[[Polisy_Developers | Polisy Developers]] : [[Polisy_Developers:ISY | ISY]] : [[Polisy_Developers:ISY:API | API]] : [[Polisy_Developers:ISY:API:Node_Server | Node Server]] : REST support in ISY

__TOC__

REST is an easy to use URL based command set which allows the developer to communicate with the ISY.

Unless otherwise specified, all REST commands use HTTP GET method.

See [[Polisy_Developers:ISY:API:Appendix:REST_Return_Codes | REST return codes]]

Notes:
* URL Prefix: /rest/ns/<profileNumber>/
* The profileNumber specified on the URL determines which ISY userid/password will be accepted by the ISY for the request.
* Maximum URL size is 255 bytes

==Node Management==

/'''nodes'''/''<nodeAddress>''/'''add'''/''<nodeDefId>''?'''primary'''=''<primary>''&'''name'''=''<nodeName>''[&'''nls'''=''<nlsKey>'']

Adds a node to the ISY. To make this node the primary, set ''primary'' to the same value as ''nodeAddress''

{|
|'''''nodeAddress''''' || The full address of the node (e.g. 'n005_dimmer_1')
|-
|'''''nodeDefId''''' || The id of the node definition to use for this node
|-
|'''''primary''''' || The primary node for the device this node belongs to
|-
|'''''nodeName''''' || The name of the node
|-
|'''''nls''''' || ''(Optional)'' NLS key string for information specific to this node
|}

E.g.
{| style="font-family: courier;"
|/rest/ns/5/nodes/n005_dimmer_2/add/MyDimmer?primary=n005_dimmer_1&name=Dimmer 2&nls=012B
|}

----
'''/add/nodes'''

Sends a request to the node server to have it add all of its nodes to the ISY. This API is intended for ISY clients, and is never used by a node server.

E.g.
{| style="font-family: courier;"
|/rest/ns/5/add/nodes
|}

----
/'''nodes'''/''<nodeAddress>''/'''change'''/''<nodeDefId>''[?'''nls'''=''<nlsKey>'']

Changes the node definition to use for an existing node. An example of this is may be to change a thermostat node from Fahrenheit to Celsius.
{|
|'''''nodeAddress''''' || The full address of the node (e.g. 'n005_dimmer_1')
|-
|'''''nodeDefId''''' || The id of the node definition to use for this node
|-
|'''''nls''''' || ''(Optional)'' NLS key string for information specific to this node
|}

E.g.
{| style="font-family: courier;"
|/rest/ns/5/nodes/n005_tstat_1/change/ThermostatCelsius?nls=4511
|}

----
/'''nodes'''/''<nodeAddress>''/'''remove'''

Removes a node from the ISY. A node cannot be removed if it is the primary node for at least one other node.
{|
|'''''nodeAddress''''' || The full address of the node (e.g. 'n005_dimmer_1')
|}

E.g.
{| style="font-family: courier;"
|/rest/ns/5/nodes/n005_dimmer_2/remove
|}

----
/'''nodes'''/''<nodeAddress>''/'''rename'''/''<newName>''
''(First available in Polisy 5.4.3)''

Renames an existing node.
{|
|'''''nodeAddress''''' || The full address of the node (e.g. 'n005_dimmer_1')
|-
|'''''newName''''' || The new name of the node
|}

E.g.
{| style="font-family: courier;"
|/rest/ns/5/nodes/n005_dimmer_2/rename/Kitchen Dimmer
|}

----
/'''nodes'''/''<nodeAddress>''/'''set'''/'''hint'''/''<value>''

Adds a hint to the node. This ISY stores the value with the node but does not use this value in any way.
{|
|'''''nodeAddress''''' || The full address of the node (e.g. 'n005_dimmer_1')
|-
|'''''value''''' ||A four byte integer
|}

E.g.
{| style="font-family: courier;"
|/rest/ns/5/nodes/n005_dimmer_2/set/hint/101
|}

==Reporting status updates==

{|
|/'''nodes'''/''<nodeAddress>''/'''report'''/'''status'''
|-
|/'''nodes'''/''<nodeAddress>''/'''report'''/'''status'''/''<statusName>''/''<value>''/''<uom>''
|}

'''[?'''&zwnj;''<s1>.<uom1>=<val1>&<s2>.<uom2>=<val2>&<s3>…''&zwnj;''']'''

Updates the ISY with the current value of one or more node status values (e.g. the current temperature, light level, etc.)

{|
|'''''nodeAddress''''' || The full address of the node (e.g. 'n005_dimmer_1')
|-
|'''''statusName, sN''''' || The name of the status value (e.g. 'ST', 'CLIHUM', etc.)
|-
|'''''value, valN''''' || The numeric status value (e.g. '80.5')
|-
|'''''uom, uomN''''' || Unit of measure of the status value
|}

E.g.
{| style="font-family: courier;"
|/rest/ns/5/nodes/n005_dimmer_2/report/status/ST/25.2/percent
|-
|/rest/ns/5/nodes/n005_dimmer_2/report/status?ST.percent=25.2
|-
|/rest/ns/2/nodes/n002_tstat_1/report/status/ST/68/17?CLISPC.uom17=76.5&CLISPH.uom17=64
|-
|/rest/ns/2/nodes/n002_tstat_1/report/status?ST.uom17=68&CLISPC.uom17=76.5&CLISPH.uom17=64
|}

==Reporting a command==

{|
|/'''nodes'''/''<nodeAddress>''/'''report'''/'''cmd'''/''<command>''
|-
|/'''nodes'''/''<nodeAddress>''/'''report'''/'''cmd'''/''<command>''/''<value>''
|-
|/'''nodes'''/''<nodeAddress>''/'''report'''/'''cmd'''/''<command>''/''<value>''/''<uom>''
|}

'''[?'''&zwnj;''<p1>.<uom1>=<val1>&<p2>.<uom2>=<val2>&<p3>…''&zwnj;''']'''

Sends a command to the ISY that may be used in programs and/or scenes. A common use of this is a physical switch that somebody turns on or off. Each time the switch is used, a command should be reported to the ISY. These are used for scenes and control conditions in ISY programs.
{|
|'''''nodeAddress''''' || The full address of the node (e.g. 'n005_switch_1)
|-
|'''''command''''' || The command to perform (e.g. 'DON', 'CLISPH', etc.)
|-
|'''''pN''''' || ''Nth'' Parameter name (e.g. 'level')
|-
|'''''uomN''''' || Unit of measure of the ''Nth'' parameter (e.g. 'seconds', 'uom58')
|-
|'''''valN''''' || The numeric value of the ''Nth'' parameter (e.g. '80', '80.01' etc,)
|}

Commands may also have an unnamed parameter
{|
|'''''value''''' || The value of the unnamed parameter.
|-
|'''''uom''''' || Unit of measure of the value of the unnamed parameter
|}

E.g.
{| style="font-family: courier;"
|/rest/ns/5/nodes/n005_switch_1/report/cmd/DON
|-
|/rest/ns/5/nodes/n005_switch_1/report/cmd/DON/80/percent
|-
|/rest/ns/5/nodes/n005_switch_1/report/cmd/DON?level.percent=80
|-
|/rest/ns/5/nodes/n005_switch_1/report/cmd/DON/80/percent?rate.uom58=0.3
|}

==Reporting ISY Request status==
{|
|/'''report'''/'''request'''/''<requestId>''/'''success'''
|-
|/'''report'''/'''request'''/''<requestId>''/'''failed'''
|-
|/'''report'''/'''request'''/''<requestId>''/'''unsupported'''
|}
When the ISY sends a request to the node server, the request may contain a ''requestId'' field.
This indicates to the node server that when the request is completed, it must send a fail or
success report for that request. This allows the ISY to in effect, have the node server
synchronously perform tasks. This message must be sent after all other messages related to the
task have been sent.

For example, if the ISY sends a request to query a node, all the results of the query must be sent
to the ISY before a fail/success/unsupported report is sent.
{|
|'''''requestId''''' || The request ID the ISY supplied on a request to the node server.
|}

E.g.
{| style="font-family: courier;"
|/rest/ns/5/report/request/1234/success
|}

==Additional REST APIs==
=== [[Polisy_Developers:ISY:API:Node_Server:Configuration#REST_API| Configuration]] ===
=== [[Polisy_Developers:ISY:API:Scene_Support:Scenes#Link_Management| Scenes]] ===
=== [[Polisy_Developers:ISY:API:System_Editors | System Editors]] ===

Polisy Developers:ISY:API:Appendix:Node Definitions

2022-04-04T23:23:48Z

Chris: Fix link to status names

Polisy Developers:ISY:API:Node Server

2022-03-22T14:42:51Z

Chris: Copied from Isy V5

[[Polisy_Developers | Polisy Developers]] : [[Polisy_Developers:ISY | ISY]] : [[Polisy_Developers:ISY:API | API]] : Node Server

With the introduction of Node Servers, the ISY supports any protocol implemented
by a third party in much the same way that INSTEON, Z-Wave and Zigbee are supported
natively in the ISY. The concepts remain the same. The difference is that instead
of the ISY generating the events and running device commands, the node server does.

== Node Server ==
* [[Polisy_Developers:ISY:API:What_is_a_Node | What is a Node?]]
* [[Polisy_Developers:ISY:API:Node_Server:Configuration | Node Server Configuration in ISY]]
* [[Polisy_Developers:ISY:API:Node_Server:REST_Support_in_ISY | REST Support in ISY]]
* [[Polisy_Developers:ISY:API:Node_Server:REST_Support_in_Node_Server | REST Support in Node Server]]
* [[Polisy_Developers:ISY:API:NLS:Language_Support | National Language Support (NLS)]]
* [[Polisy_Developers:ISY:API:NLS:Formatting_for_Programs | Formatting for Programs]]

=== Scenes ===
* [[Polisy_Developers:ISY:API:Scene_Support:Native Links | Native Links]]
* [[Polisy_Developers:ISY:API:Scene_Support:Scenes | Scenes]]

=== Appendix ===
* [[Polisy_Developers:ISY:API:Appendix:Editors | Editors]]
* [[Polisy_Developers:ISY:API:Appendix:Icons | Icons]]
* [[Polisy_Developers:ISY:API:Appendix:Links | Links ]]
* [[Polisy_Developers:ISY:API:Appendix:Link_Definitions | Link Definitions]]
* [[Polisy_Developers:ISY:API:Appendix:Node_Definitions | Node Definitions]]
* [[Polisy_Developers:ISY:API:Appendix:REST_Return_Codes | REST Return Codes]]
* [[Polisy_Developers:ISY:API:Appendix:Status_Names | Status Names]]
* [[Polisy_Developers:ISY:API:Appendix:Units_of_Measure | Units of Measure (UOM)]]

Polisy Developers:ISY:API:Scene Support:Scenes

2022-03-22T13:58:08Z

Chris: Copied from Isy V5

[[Polisy_Developers | Polisy Developers]] : [[Polisy_Developers:ISY | ISY]] : [[Polisy_Developers:ISY:API | API]] : Scene Support : ISY Scenes

==Scenes==

The terminology for ''scene'' has dual meanings in ISY because in some cases it describes the
group (scene) object that contains a set of controller and responder nodes, and in others it
describes a single controller (and its links to responders) within the group (scene).

;Controller
:A node such as a light switch that can control responders (e.g. can turn something on/off)
:In some cases, a controller may also be a responder.
;Responder
:A node such as a lamp that can be controlled by a controller (e.g. can be turned on/off)
;Group
:Often referred to as a scene, a group is an object containing a collection controllers and responders. It may contain many controllers and many responders. The group itself acts as a scene controller that also supports native Insteon links.
;Scene
:A single controller linked to one or more responders.

ISY scenes define how controllers control and communicate with responders in the scene. The ISY group itself acts as a controller and therefore also has links to all of the responders in the scene.

<pre>
https://<isy>/rest/links/groups/39520

<groups>
<group id="39520">
<ctl id="1B 99 17 1">
<rsp>
<link linkdef="I_DIMMER" type="native" node="A B9 44 1">

<val uom="51" prec="0">85</val>


<val uom="25" prec="0">27</val>

</link>
<link linkdef="I_TEMPLINC" type="native" node="1D 6F 15 1">

<val uom="14" prec="0">61</val>


<val uom="14" prec="0">81</val>


<val uom="99" prec="0">8</val>


<val uom="98" prec="0">3</val>


<val uom="2" prec="0">0</val>

</link>
<link type="ignore" node="ZW060_1"/>
<link type="default" node="ZW033_1"/>
<link type="default" node="1B 99 17 1"/>
</rsp>
</ctl>
<ctl id="39520">
<rsp>
<link linkdef="I_DIMMER" type="native" node="A B9 44 1">

<val uom="51" prec="0">100</val>


<val uom="25" prec="0">31</val>

</link>
<link linkdef="I_DIMMER" type="native" node="1B 99 17 1">

<val uom="51" prec="0">100</val>


<val uom="25" prec="0">31</val>

</link>
<link linkdef="I_TEMPLINC" type="native" node="1D 6F 15 1">

<val uom="14" prec="0">68</val>


<val uom="14" prec="0">75</val>


<val uom="99" prec="0">8</val>


<val uom="98" prec="0">3</val>


<val uom="2" prec="0">0</val>

</link>
<link type="cmd" node="ZW060_1" cmd="CLIMD">

<val uom="67" prec="0">3</val>

</link>
<link type="default" node="ZW033_1"/>
</rsp>
</ctl>
</group>
</groups>
</pre>

==Link Types==

===Native===
''type="native"''

A direct link between the controller and the responder (e.g. Insteon links, Z-Wave associations, etc.).
''(Controller→Responder)''

For more information see [[Polisy_Developers:ISY:API:Scene_Support:Native_Links | Native Links]]

===Command===
''type="cmd"''

Same as ''Default'' except when the controller sends an ''On'' command the ISY sends the command specified in the link to the responder.
''(Controller→ISY→Responder)''

===Default===
''type="default"''

Whatever command is sent by the controller is forwarded to the responder by the ISY.
''(Controller→ISY→Responder)''

===Ignore===
''type="ignore"''

No link is made between the controller and responder.

== Link Management ==
Unless otherwise specified, all REST commands use HTTP GET method.

See [[Polisy_Developers:ISY:API:Appendix:REST_Return_Codes | REST return codes]]

Notes:
* URL Prefix: /rest

----
/'''links'''[/'''groups'''/''<groupId>''[/'''controllers'''/''controllerId''[/'''responders'''/''<responderId>'']]]

Returns all the [[Polisy_Developers:ISY:API:Appendix:Links | links]], or just the links for the specified group, controller and/or responder.

{|
|'''''groupId'''''
| The node address of the ISY group (scene) node. If not specified then return all links.
|-
|'''''controllerId'''''
| The ISY node address of a controller in the group. If not specified then return all links for the group.
|-
|'''''responderId'''''
| The ISY node address of a responder in the group. If not specified then return all links for the controller.
|-
|}

{| style="font-family: courier;"
|e.g.
|-
|/rest/links
|-
|/rest/links/group/39520/
|-
|/rest/links/group/39520/controllers/1B 99 17 1
|-
|/rest/links/group/39520/controllers/1B 99 17 1/responders/1D 6F 15 1
|}

----
/'''links'''/'''groups'''/''<groupId>''/'''member'''/<memberId>''/'''remove'''

Remove the node from the group. All links to and from this node with other controllers and responders in the group are also removed.

{|
|'''''groupId''''' || The address of the ISY group node containing the node to be removed
|-
|'''''memberId''''' || The address of the node to be removed
|}

{| style="font-family: courier;"
| e.g. /rest/links/groups/21151/member/ZW017_1/remove
|}

----
/'''links'''/'''groups'''/''<groupId>''/'''controllers'''/''controllerId''/'''responders'''/''<responderId>''/'''update'''/'''default'''

Change the link between ''controllerId'' and ''responderId'' to link type ''default''

{|
|'''''groupId''''' || The address of the ISY group node containing the controller and responder
|-
|'''''controllerId''''' || The node address of the controller
|-
|'''''responderId''''' || The node address of the responder
|}

{| style="font-family: courier;"
|e.g. /rest/links/groups/21151/controllers/ZW010_1/responders/ZW017_1/update/default
|}

----
/'''links'''/'''groups'''/''<groupId>''/'''controllers'''/''controllerId''/'''responders'''/''<responderId>''/'''update'''/'''ignore'''

Change the link between ''controllerId'' and ''responderId'' to link type ''ignore''

{|
|'''''groupId''''' || The address of the ISY group node containing the controller and responder
|-
|'''''controllerId''''' || The node address of the controller
|-
|'''''responderId''''' || The node address of the responder
|}

{| style="font-family: courier;"
|e.g. /rest/links/groups/21151/controllers/ZW010_1/responders/ZW017_1/update/ignore
|}

----
/'''links'''/'''groups'''/''<groupId>''/'''controllers'''/''controllerId''/'''responders'''/<responderId>/'''update'''/'''linkdef'''/''<linkDefId>''[?''<p1>.<uom1>=<val1>&<p2>.<uom2>=<val2>&<p3>…'']

Change the link between ''controllerId'' and ''responderId'' to link type ''native''.

{|
|'''''groupId''''' || The address of the ISY group node containing the controller and responder
|-
|'''''controllerId''''' || The node address of the controller
|-
|'''''responderId''''' || The node address of the responder
|-
|'''''linkDefId''''' || The id of the [[Polisy_Developers:ISY:API:Appendix:Link_Definitions | link definition]]
|-
|'''''pN''''' || ''Nth'' Parameter name (e.g. 'ol')
|-
|'''''uomN''''' || Unit of measure of the ''Nth'' parameter (e.g. 'seconds', 'uom58')
|-
|'''''valN''''' || The numeric value of the ''Nth'' parameter (e.g. '80', '80.01' etc,)
|}

{| style="font-family: courier;"
|e.g. /rest/links/groups/21151/controllers/1 FA 19 1/responders/A 5E 21 1/update/linkdef/I_STD?ol.percent=85&rr.uom25=30
|-
|}

----
/'''links'''/'''groups'''/''<groupId>''/'''controllers'''/''controllerId''/'''responders'''/''<responderId>''/'''update'''/'''linkdef'''/''<linkDefId>''/'''cmd'''/''<command>''[/''<value>''[/''<uom>'']][?''<p1>.<uom1>=<val1>&<p2>.<uom2>=<val2>&<p3>…'']

Change the link between ''controllerId'' and ''responderId'' to link type ''native'' with a command. ''(Controller→Responder)''

{|
|'''''groupId''''' || The address of the ISY group node containing the controller and responder
|-
|'''''controllerId''''' || The node address of the controller
|-
|'''''responderId''''' || The node address of the responder
|-
|'''''linkDefId''''' || The id of the [[Polisy_Developers:ISY:API:Appendix:Link_Definitions | link definition]]
|-
|'''''command''''' || The command to be used in the link (e.g. 'DON', 'CLISPH', etc.)
|-
|'''''pN''''' || ''Nth'' Parameter name (e.g. 'level')
|-
|'''''uomN''''' || Unit of measure of the ''Nth'' parameter (e.g. 'seconds', 'uom58')
|-
|'''''valN''''' || The numeric value of the ''Nth'' parameter (e.g. '80', '80.01' etc,)
|}

Commands may also have an unnamed parameter
{|
|'''''value''''' || The value of the unnamed parameter.
|-
|'''''uom''''' || Unit of measure of the value of the unnamed parameter
|}

{| style="font-family: courier;"
| e.g.
|-
|/rest/links/groups/21151/controllers/ZW010_1/responders/ZW017_1/update/linkdef/ASSOC_CMD/cmd/DON
|-
|/rest/links/groups/21151/controllers/ZW010_1/responders/ZW017_1/update/linkdef/ASSOC_CMD/cmd/DON/80
|-
|/rest/links/groups/21151/controllers/ZW010_1/responders/ZW017_1/update/linkdef/ASSOC_CMD/cmd/DON/80/percent
|-
|/rest/links/groups/21151/controllers/ZW010_1/responders/ZW017_1/update/linkdef/ASSOC_CMD/cmd/DON?level.percent=80
|-
|/rest/links/groups/21151/controllers/ZW010_1/responders/ZW017_1/update/linkdef/ASSOC_CMD/cmd/DON/80/percent?rate.uom58=0.3
|}

----
/'''links'''/'''groups'''/''<groupId>''/'''controllers'''/''controllerId''/'''responders'''/''<responderId>''/'''update'''/'''cmd'''/''<command>''[/''<value>''[/''<uom>'']][?''<p1>.<uom1>=<val1>&<p2>.<uom2>=<val2>&<p3>…'']

Change the link between ''controllerId'' and ''responderId'' to link type ''command''. ''(Controller→ISY→Responder)''

{|
|'''''groupId''''' || The address of the ISY group node containing the controller and responder
|-
|'''''controllerId''''' || The node address of the controller
|-
|'''''responderId''''' || The node address of the responder
|-
|'''''command''''' || The command to be used in the link (e.g. 'DON', 'CLISPH', etc.)
|-
|'''''pN''''' || ''Nth'' Parameter name (e.g. 'level')
|-
|'''''uomN''''' || Unit of measure of the ''Nth'' parameter (e.g. 'seconds', 'uom58')
|-
|'''''valN''''' || The numeric value of the ''Nth'' parameter (e.g. '80', '80.01' etc,)
|}

Commands may also have an unnamed parameter
{|
|'''''value''''' || The value of the unnamed parameter.
|-
|'''''uom''''' || Unit of measure of the value of the unnamed parameter
|}

{| style="font-family: courier;"
| e.g.
|-
|/rest/links/groups/21151/controllers/ZW010_1/responders/ZW017_1/update/cmd/DON
|-
|/rest/links/groups/21151/controllers/ZW010_1/responders/ZW017_1/update/cmd/DON/80
|-
|/rest/links/groups/21151/controllers/ZW010_1/responders/ZW017_1/update/cmd/DON/80/percent
|-
|/rest/links/groups/21151/controllers/ZW010_1/responders/ZW017_1/update/cmd/DON?level.percent=80
|-
|/rest/links/groups/21151/controllers/ZW010_1/responders/ZW017_1/update/cmd/DON/80/percent?rate.uom58=0.3
|}