Difference between revisions of "AIO API Event Codes"

From OpenMotics
Jump to navigation Jump to search
(48 intermediate revisions by the same user not shown)
Line 100: Line 100:
 
|Brightness sensor x changed: This Event will be send when Brightness sensor x has changed, new humidity will be found in y
 
|Brightness sensor x changed: This Event will be send when Brightness sensor x has changed, new humidity will be found in y
 
|-
 
|-
!<div align="center">20</div>
+
!<div align="center">2</div>
!<div align="center">0</div>
+
!<div align="center">3</div>
 
!<div align="center">0</div>
 
!<div align="center">0</div>
 
!<div align="center">x</div>
 
!<div align="center">x</div>
!<div align="center">Mode</div>
+
!<div align="center">y.MSB</div>
!<div align="center">Setpoint</div>
+
!<div align="center">y.LSB</div>
!<div align="center">0</div>
+
!<div align="center">z.MSB</div>
!<div align="center">0</div>
+
!<div align="center">z.LSB</div>
|Thermostat x has changed: The Thermostat setpoint/mode has been modified by the slave device (For example the Modbus thermostat connected to the Micro CAN has an updated value set by the user)
+
|Air quality sensor x changed: This Event will be send when values sensor x have changed, new CO2 will be found in y and VOC in z.
 
|-
 
|-
 
!<div align="center">20</div>
 
!<div align="center">20</div>
Line 139: Line 139:
 
!<div align="center">BA Extra Parameter.LSB</div>
 
!<div align="center">BA Extra Parameter.LSB</div>
 
|When BB debug mode is ON (see Eeprom Memory model Page 0 Byte 13), this Event will be send to the BB for every BA that has been executed.  
 
|When BB debug mode is ON (see Eeprom Memory model Page 0 Byte 13), this Event will be send to the BB for every BA that has been executed.  
 +
|-
 +
!<div align="center">23</div>
 +
!<div align="center">0</div>
 +
!<div align="center">0</div>
 +
!<div align="center">ID2</div>
 +
!<div align="center">ID1</div>
 +
!<div align="center">ID0</div>
 +
!<div align="center">-</div>
 +
!<div align="center">-</div>
 +
|uCAN with ID2.ID1.ID0 is not responding.
 +
|-
 +
!<div align="center">24</div>
 +
!<div align="center">0</div>
 +
!<div align="center">0</div>
 +
!<div align="center">ID3</div>
 +
!<div align="center">ID2</div>
 +
!<div align="center">ID1</div>
 +
!<div align="center">ID0</div>
 +
!<div align="center">-</div>
 +
|RS485 module with ID3.ID2.ID1.ID0 is not responding.
 +
|-
 +
!<div align="center">245</div>
 +
!<div align="center">0</div>
 +
!<div align="center">0</div>
 +
!<div align="center">type</div>
 +
!<div align="center">Module ID0</div>
 +
!<div align="center">Module ID1</div>
 +
!<div align="center">Module ID2</div>
 +
!<div align="center">Module ID3</div>
 +
|Module Discover event: During initialisation, when existing or double module has been found, this event will be sent.
 +
* type==5: Existing Output module has been found
 +
* type==6: Existing Input module has been found
 +
* type==7: Existing Sensor module has been found
 +
* type==8: Existing CAN Control module has been found
 +
* type==9: Double Output module has been found
 +
* type==10: Double Input module has been found
 +
* type==11: Double Sensor module has been found
 +
* type==12: Double CAN Control module has been found 
 +
|-
 +
!<div align="center">246</div>
 +
!<div align="center">0</div>
 +
!<div align="center">0</div>
 +
!<div align="center">0</div>
 +
!<div align="center">type</div>
 +
!<div align="center">Automatic Module Discover Byte</div>
 +
!<div align="center">0</div>
 +
!<div align="center">0</div>
 +
|Slave module Search Event: When type==0: Search is not active, when type==1: Search is started, when type==2: Search is done. For Automatic Module Discovery Byte, see Eeprom Memory model Page 0 Byte 11
 +
|-
 +
!<div align="center">247</div>
 +
!<div align="center">Type</div>
 +
!<div align="center">Data0</div>
 +
!<div align="center">Data1</div>
 +
!<div align="center">Data2</div>
 +
!<div align="center">Data3</div>
 +
!<div align="center">Data4</div>
 +
!<div align="center">Data5</div>
 +
|Data to be send to the BB:
 +
*type=0->PCB temperature has changed (temperature can be found in Data1)
 +
|-
 +
!<div align="center">248</div>
 +
!<div align="center">0</div>
 +
!<div align="center">0</div>
 +
!<div align="center">0</div>
 +
!<div align="center">type</div>
 +
!<div align="center">0</div>
 +
!<div align="center">0</div>
 +
!<div align="center">0</div>
 +
|Eeprom activate has just been fully performed and is finished. When type==1: A regular Eeprom activate has been performed, when type==0: An Eeprom activate has been performed just after a power reset.
 +
|-
 +
!<div align="center">248</div>
 +
!<div align="center">2</div>
 +
!<div align="center">0</div>
 +
!<div align="center">0</div>
 +
!<div align="center">cause</div>
 +
!<div align="center">0</div>
 +
!<div align="center">0</div>
 +
!<div align="center">0</div>
 +
|A power Reset of the I2C Bus has been initiated due to I2C problem (cause=1->I2C1, cause=2->I2C2).
 +
|-
 +
!<div align="center">248</div>
 +
!<div align="center">3</div>
 +
!<div align="center">0</div>
 +
!<div align="center">0</div>
 +
!<div align="center">type</div>
 +
!<div align="center">current health</div>
 +
!<div align="center">previous health</div>
 +
!<div align="center">0</div>
 +
|This event indicates the health status:
 +
*Type=0->CAN Health status change
 +
**Current&previous health:
 +
***Health=0: Value at startup
 +
***Health=1: All uCAN's are not responding
 +
***Health=2: All uCAN's OK
 +
***Health=3: Not all uCAN's are responding
 +
***Health=4: CAN bus is temporary in OFF state due to bus errors
 
|-
 
|-
 
!<div align="center">249</div>
 
!<div align="center">249</div>
Line 191: Line 287:
 
|-
 
|-
 
!<div align="center">254</div>
 
!<div align="center">254</div>
 +
!<div align="center">type</div>
 
!<div align="center">0</div>
 
!<div align="center">0</div>
!<div align="center">0</div>
+
!<div align="center">Reset_mode</div>
!<div align="center">0</div>
+
!<div align="center">cause</div>
!<div align="center">0</div>
+
!<div align="center">Fw Version Major</div>
!<div align="center">0</div>
+
!<div align="center">Fw Version Minor</div>
!<div align="center">0</div>
+
!<div align="center">Fw Version Built</div>
!<div align="center">0</div>
+
|Reset Action:
|Update of the Onboard Main PCB temperature. Temperature is represented as a signed integer.
+
*type=2->Health checker is requesting reset in a few seconds
|-
+
**cause=1->I2C Bus 1 (Eeprom) problem
!<div align="center">254</div>
+
**cause=2->I2C Bus 2 (Fram, front panel leds, Front panel DA, RTC etc) problem
!<div align="center">1</div>
+
**cause=3->CAN problem
!<div align="center">0</div>
+
*type=253->CAN stack reset
!<div align="center">0</div>
+
*type=254->Processor reset (or power startup) has just been performed
!<div align="center">Onboard_temp</div>
+
*Reset_mode:
!<div align="center">0</div>
+
**Reset_mode=1: Reset functionality for CAN reset is enabled
!<div align="center">0</div>
+
**Reset_mode=0: Reset functionality for CAN reset is disabled
!<div align="center">0</div>
 
|Update of the Onboard Main PCB temperature. Temperature is represented as a signed integer.
 
|-
 
!<div align="center">254</div>
 
!<div align="center">2</div>
 
!<div align="center">0</div>
 
!<div align="center">0</div>
 
!<div align="center">0</div>
 
!<div align="center">0</div>
 
!<div align="center">0</div>
 
!<div align="center">0</div>
 
|Processor reset (or power startup) has just been performed
 
 
|-
 
|-
 
|}
 
|}
Line 236: Line 321:
 
!Description
 
!Description
 
|-
 
|-
!<div align="center">Chip 1 / Led 10</div>
+
!<div align="center">NA</div>
 
!<div align="center">Chip 0 / Led 1</div>
 
!<div align="center">Chip 0 / Led 1</div>
 
|EXP BUS (0)
 
|EXP BUS (0)
 
|-
 
|-
!<div align="center">Chip 1 / Led 8</div>
+
!<div align="center">Chip 0 / Led 5</div>
 
!<div align="center">Chip 0 / Led 3</div>
 
!<div align="center">Chip 0 / Led 3</div>
 
|LED ST GREEN (1)
 
|LED ST GREEN (1)
 
|-
 
|-
!<div align="center">Chip 1 / Led 9</div>
+
!<div align="center">Chip 0 / Led 4</div>
 
!<div align="center">Chip 0 / Led 2</div>
 
!<div align="center">Chip 0 / Led 2</div>
 
|LED ST RED (2)
 
|LED ST RED (2)
 
|-
 
|-
!<div align="center">Chip 1 / Led 3</div>
+
!<div align="center">Chip 1 / Led 4</div>
 
!<div align="center">Chip 0 / Led 12</div>
 
!<div align="center">Chip 0 / Led 12</div>
 
|LED CAN ST GREEN (3)
 
|LED CAN ST GREEN (3)
 
|-
 
|-
!<div align="center">Chip 1 / Led 2</div>
+
!<div align="center">Chip 1 / Led 5</div>
 
!<div align="center">Chip 0 / Led 11</div>
 
!<div align="center">Chip 0 / Led 11</div>
 
|LED CAN ST RED (4)
 
|LED CAN ST RED (4)
 
|-
 
|-
!<div align="center">Chip 1 / Led 4</div>
+
!<div align="center">Chip 1 / Led 15</div>
 
!<div align="center">Chip 0 / Led 10</div>
 
!<div align="center">Chip 0 / Led 10</div>
 
|LED CAN COM (5)
 
|LED CAN COM (5)
 
|-
 
|-
!<div align="center">Chip 1 / Led 5</div>
+
!<div align="center">Chip 1 / Led 13</div>
 
!<div align="center">Chip 0 / Led 9</div>
 
!<div align="center">Chip 0 / Led 9</div>
 
|LED P1 (6)
 
|LED P1 (6)
 
|-
 
|-
!<div align="center">Chip 1 / Led 14</div>
+
!<div align="center">Chip 1 / Led 12</div>
 
!<div align="center">Chip 0 / Led 8</div>
 
!<div align="center">Chip 0 / Led 8</div>
 
|LED LAN GREEN (7)
 
|LED LAN GREEN (7)
 
|-
 
|-
!<div align="center">Chip 1 / Led 15</div>
+
!<div align="center">Chip 1 / Led 11</div>
 
!<div align="center">Chip 0 / Led 5</div>
 
!<div align="center">Chip 0 / Led 5</div>
 
|LED LAN RED (8)
 
|LED LAN RED (8)
 
|-
 
|-
!<div align="center">Chip 1 / Led 12</div>
+
!<div align="center">Chip 0 / Led 14</div>
 
!<div align="center">Chip 0 / Led 6</div>
 
!<div align="center">Chip 0 / Led 6</div>
 
|LED CLOUD (9)
 
|LED CLOUD (9)
 
|-
 
|-
!<div align="center">Chip 1 / Led 11</div>
+
!<div align="center">Chip 0 / Led 13</div>
 
!<div align="center">Chip 0 / Led 7</div>
 
!<div align="center">Chip 0 / Led 7</div>
 
|LED SETUP (10)
 
|LED SETUP (10)
Line 290: Line 375:
 
!<div align="center">NA</div>
 
!<div align="center">NA</div>
 
!<div align="center">Chip 1 / Led 7</div>
 
!<div align="center">Chip 1 / Led 7</div>
|LED DIG OUT 6-8 (13)
+
|LED DIG OUT 1-4 (13)
 
|-
 
|-
 
!<div align="center">NA</div>
 
!<div align="center">NA</div>
 
!<div align="center">Chip 0 / Led 13</div>
 
!<div align="center">Chip 0 / Led 13</div>
|LED DIG OUT 1-5 (14)
+
|LED DIG OUT 5-7 (14)
 +
|-
 +
!<div align="center">NA</div>
 +
!<div align="center">Chip 0 / Led 14</div>
 +
|LED DIG ANA 1-4 (15)
 
|-
 
|-
 
!<div align="center">NA</div>
 
!<div align="center">NA</div>
 
!<div align="center">Chip 0 / Led 0</div>
 
!<div align="center">Chip 0 / Led 0</div>
|LED INPUTS (15)
+
|LED INPUTS (16)
 
|-
 
|-
 
|}
 
|}
  
 
* Note3: See [[Micro CAN Events]]
 
* Note3: See [[Micro CAN Events]]

Revision as of 08:17, 21 September 2021

Type Action DeviceNr.MSB DeviceNr.LSB Data0 Data1 Data2 Data3 Description
0
0
x.MSB
x.LSB
y
z
u.MSB
u.LSB
Output x off: This Event will be send when an output is switched off with dimmer value y, timer type z and timer value u. See Note 1.
0
1
x.MSB
x.LSB
y
z
u.MSB
u.LSB
Output x on: This Event will be send when an output is switched on with dimmer value y, timer type z and timer value u. See Note 1.
0
2
x.MSB
x.LSB
y
-
-
-
Output x lock/unlock status: This Event will be send when output x is locked/unlock. y=0->Unlock, y=1->Lock
1
0
x.MSB
x.LSB
0
0
0
0
Input x Released: This Event will be send when an input is released.
1
1
x.MSB
x.LSB
0
0
0
0
Input x Pressed: This Event will be send when an input is pressed.
1
2
x.MSB
x.LSB
y
-
-
-
Input x lock/unlock status: This Event will be send when Input x is locked/unlock. y=0->Unlock, y=1->Lock
2
0
0
x
0
y
0
0
Temperature sensor x changed: This Event will be send when Temperature sensor x has changed, new temperature will be found in y
2
1
0
x
0
y
0
0
Humidity sensor x changed: This Event will be send when Humidity sensor x has changed, new humidity will be found in y
2
2
0
x
y.MSB
y.LSB
0
0
Brightness sensor x changed: This Event will be send when Brightness sensor x has changed, new humidity will be found in y
2
3
0
x
y.MSB
y.LSB
z.MSB
z.LSB
Air quality sensor x changed: This Event will be send when values sensor x have changed, new CO2 will be found in y and VOC in z.
20
0
0
x
Mode
Setpoint
0
0
Thermostat x has changed: The Thermostat setpoint/mode has been modified by the slave device (For example the Modbus thermostat connected to the Micro CAN has an updated value set by the user)
21
0
0
ID2
ID1
ID0
Data0
Data1
uCAN with ID2.ID1.ID0 reports an event with content Data0 and Data1, see Note3.
22
0
BA DeviceNr.MSB
BA DeviceNr.LSB
BA Type
BA Action
BA Extra Parameter.MSB
BA Extra Parameter.LSB
When BB debug mode is ON (see Eeprom Memory model Page 0 Byte 13), this Event will be send to the BB for every BA that has been executed.
23
0
0
ID2
ID1
ID0
-
-
uCAN with ID2.ID1.ID0 is not responding.
24
0
0
ID3
ID2
ID1
ID0
-
RS485 module with ID3.ID2.ID1.ID0 is not responding.
245
0
0
type
Module ID0
Module ID1
Module ID2
Module ID3
Module Discover event: During initialisation, when existing or double module has been found, this event will be sent.
  • type==5: Existing Output module has been found
  • type==6: Existing Input module has been found
  • type==7: Existing Sensor module has been found
  • type==8: Existing CAN Control module has been found
  • type==9: Double Output module has been found
  • type==10: Double Input module has been found
  • type==11: Double Sensor module has been found
  • type==12: Double CAN Control module has been found
246
0
0
0
type
Automatic Module Discover Byte
0
0
Slave module Search Event: When type==0: Search is not active, when type==1: Search is started, when type==2: Search is done. For Automatic Module Discovery Byte, see Eeprom Memory model Page 0 Byte 11
247
Type
Data0
Data1
Data2
Data3
Data4
Data5
Data to be send to the BB:
  • type=0->PCB temperature has changed (temperature can be found in Data1)
248
0
0
0
type
0
0
0
Eeprom activate has just been fully performed and is finished. When type==1: A regular Eeprom activate has been performed, when type==0: An Eeprom activate has been performed just after a power reset.
248
2
0
0
cause
0
0
0
A power Reset of the I2C Bus has been initiated due to I2C problem (cause=1->I2C1, cause=2->I2C2).
248
3
0
0
type
current health
previous health
0
This event indicates the health status:
  • Type=0->CAN Health status change
    • Current&previous health:
      • Health=0: Value at startup
      • Health=1: All uCAN's are not responding
      • Health=2: All uCAN's OK
      • Health=3: Not all uCAN's are responding
      • Health=4: CAN bus is temporary in OFF state due to bus errors
249
0
x.MSB
x.LSB
y.MSB
y.LSB
0
z
This event will be send when BA251 is triggered. x, y and z are the parameters received from BA251.
250
0
0
Button_nr
Status
0
0
0
Front Panel Button change: The Frontpanel of the Core has 3 buttons, the Core+ has 4 buttons. When a Button is pressed (short press, longer press), an event will be send. Button_nr: 0->Setup Button, 1->Action Button, 2->CAN Power Button, 3->Select Button. Status: 0->Button released, 1->Button pressed, 2->Button pressed for 5 seconds, 3->Button pressed longer then 8 seconds.
251
Chip_Nr
Led_Blinking_25.MSB
Led_Blinking_25.LSB
Led_Blinking_50.MSB
Led_Blinking_50.LSB
Led_Blinking_75.MSB
Led_Blinking_75.LSB
Front Panel Led state change: When a Led of the Front Panel changes state (from ON to OFF or the reverse), an event message will be send. 2 led driver chips (Chip_nr 0 and 1) are present on the Front panel. The 16 bit Led_blinking_25 will indicate for the 16 leds if the led is blinking at 25% (BIT=1) or not (BIT=0), Led_blinking_50 for 50% and Led_blinking_75 for 75% ON (and thus 25% of the time OFF). See Note 2
252
Chip_Nr
0
0
Led_status.MSB
Led_status.LSB
0
0
Front Panel Led state change: When a Led of the Front Panel changes state (from ON to OFF or the reverse), an event message will be send. 2 led driver chips (Chip_nr 0 and 1) are present on the Front panel. The 16 bit Led_status will indicate for 16 leds if the led is ON (BIT=1) or OFF (BIT=0). See Note 2.
253
0
0
Bus
Power_state
0
0
0
Power state change: When Bus=0 -> RS485 Bus, When Bus=1 -> CAN Bus, when Power_state=0 -> Bus OFF, when Power_state=1 -> Bus ON
254
type
0
Reset_mode
cause
Fw Version Major
Fw Version Minor
Fw Version Built
Reset Action:
  • type=2->Health checker is requesting reset in a few seconds
    • cause=1->I2C Bus 1 (Eeprom) problem
    • cause=2->I2C Bus 2 (Fram, front panel leds, Front panel DA, RTC etc) problem
    • cause=3->CAN problem
  • type=253->CAN stack reset
  • type=254->Processor reset (or power startup) has just been performed
  • Reset_mode:
    • Reset_mode=1: Reset functionality for CAN reset is enabled
    • Reset_mode=0: Reset functionality for CAN reset is disabled

Notes:

  • Note 1: timer type specifies which kind of timer is active for a given output and his timer value.
    • timer type=0: No timer is active
    • timer type=1: 100ms timer
    • timer type=2: 1s timer
    • timer type=3: 1m timer
  • Note 2:

Front Panel Led Events

Core Core+ Description
NA
Chip 0 / Led 1
EXP BUS (0)
Chip 0 / Led 5
Chip 0 / Led 3
LED ST GREEN (1)
Chip 0 / Led 4
Chip 0 / Led 2
LED ST RED (2)
Chip 1 / Led 4
Chip 0 / Led 12
LED CAN ST GREEN (3)
Chip 1 / Led 5
Chip 0 / Led 11
LED CAN ST RED (4)
Chip 1 / Led 15
Chip 0 / Led 10
LED CAN COM (5)
Chip 1 / Led 13
Chip 0 / Led 9
LED P1 (6)
Chip 1 / Led 12
Chip 0 / Led 8
LED LAN GREEN (7)
Chip 1 / Led 11
Chip 0 / Led 5
LED LAN RED (8)
Chip 0 / Led 14
Chip 0 / Led 6
LED CLOUD (9)
Chip 0 / Led 13
Chip 0 / Led 7
LED SETUP (10)
NA
Chip 1 / Led 6
LED RELAY 1-8 (11)
NA
Chip 0 / Led 15
LED RELAY 9-16 (12)
NA
Chip 1 / Led 7
LED DIG OUT 1-4 (13)
NA
Chip 0 / Led 13
LED DIG OUT 5-7 (14)
NA
Chip 0 / Led 14
LED DIG ANA 1-4 (15)
NA
Chip 0 / Led 0
LED INPUTS (16)