Back to Specification
Back to Level I Events

Class=20 (0x14) Information

CLASS1.INFORMATION

Description

Most of the messages below have an index parameter that can be used to indicate which of several SECO (sensor/control) units on a node originated the event. Set to zero if the node only control one item.

Type = 0 (0x00) Undefined

This is a general event of no special type.

Type = 1 (0x01) Button

A button has been pressed/released.

byte # Description
byte 0 Bits 0,1,2 If 0 the button has been released. If 1 the button is pressed. If equal to 2 this is a key value (press followed by release). Bits 3-7 is repeats 0-32.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones
byte 3 MSB of code for button.
byte 4 LSB of code for button.
byte 5 MSB of optional code-page.
byte 6 LSB of optional code-page.

Type = 2 (0x02) Mouse

A mouse movement has occurred.

byte # Description
byte 0 If zero absolute coordinates follow. If equal to one relative coordinates follow.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones
byte 3 MSB of normalized X-coordinate.
byte 4 LSB of normalized X-coordinate.
byte 5 MSB of normalized Y-coordinate.
byte 6 LSB of normalized Y-coordinate.

Type = 3 (0x03) On

A node indicates that a condition is in its on state. Heater on, lights on are two examples.

byte # Description
byte 0 index.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Byte 0 is often used as an index for channels within a module.

Type = 4 (0x04) Off

A node indicates that a condition is in its off state. Heater off, lights off are two examples.

byte # Description
byte 0 Index.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 5 (0x05) Alive

A node tells the world that it is alive.

byte # Description
byte 0 User specified.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 6 (0x06) Terminating

A node tells the world that it is terminating.

byte # Description
byte 0 User specified.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 7 (0x07) Opened

A node indicates that an open has occurred. This can be a door/window open, a modem line open etc.

byte # Description
byte 0 User specified.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 8 (0x08) Closed

A node indicates that a close has occurred. This can be a door/window close, a modem line closure etc.

byte # Description
byte 0 User specified.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 9 (0x09) Node Heartbeat

Heartbeats can be used to indicate that a unit is alive or to send periodic data. This can be sent out at predefined intervals to indicate that the node is alive, however, it does not necessarily mean the node is functioning as it should. It simply states that the node is connected to the network. To check if a node is functioning, other properties such as a measurement event or registry should be used.
This event should be sent as a response to a “Segment Status Heartbeat” (CLASS1.PROTOCOL, Type=1) in order to provide a method of finding out what is connected to the network.
The data bytes from byte 3 and forward can be used to send a descriptive/user friendly name if desired.

Not mandatory but it is recommended that all nodes send this event on regular intervals.

byte # Description
byte 0 User specified.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 10 (0x0A) Below limit

This indicates that the node has a condition that is below a configurable limit.

byte # Description
byte 0 Reserved.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 11 (0x0B) Above limit

This indicates that the node has a condition that is above a configurable limit.

byte # Description
byte 0 Reserved.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 12 (0x0C) Pulse

This can be used for slow pulse counts. This can be an S0-pulse interface or something similar.

byte # Description
byte 0 Reserved.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 13 (0x0D) Error

A node indicates that an error occurred.

byte # Description
byte 0 User specified.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 14 (0x0E) Resumed

A node indicates that it has resumed operation.

byte # Description
byte 0 Reserved.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 15 (0x0F) Paused

A node indicates that it has paused.

byte # Description
byte 0 Reserved.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 16 (0x10) Reserved

Reserved for future use.

Type = 17 (0x11) Good morning

The system should enter its morning state. This can be a user pressing a button to set his/her house to it's morning state.

byte # Description
byte 0 Reserved.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 18 (0x12) Good day

The system should enter its day state. This can be a user pressing a button to set his/her house to it's day state.

byte # Description
byte 0 Reserved.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 19 (0x13) Good afternoon

The system should enter its afternoon state. This can be a user pressing a button to set his/her house to it's afternoon state.

byte # Description
byte 0 Reserved.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 20 (0x14) Good evening

The system should enter its evening state. This can be a user pressing a button to set his/her house to it's evening state.

byte # Description
byte 0 Reserved.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 21 (0x15) Good night

The system should enter its night state. This can be a user pressing a button to set his/her house to it's night state.

byte # Description
byte 0 Reserved.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 22 (0x16) See you soon

The system should be on a temporary alert. This can be a user locking the door to go out to the waste bin or similar situation. An alarm system should not be activated in this situation.

byte # Description
byte 0 Reserved.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 23 (0x17) Goodbye

The system should be on a goodbye alert. This can be a user locking the door to go out for a day’s work or similar situation. All alarm systems should be activated in this situation.

byte # Description
byte 0 Reserved.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 24 (0x18) Stop

A node indicates that a stop event occurred. This can for example be a motor stopping.

byte # Description
byte 0 Reserved.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 25 (0x19) Start

A node indicates that a start event occurred. This can be a motor starting.

byte # Description
byte 0 Reserved.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 26 (0x1A) ResetCompleted

A node indicates that a reset occurred. This can be a node doing a warm start.

byte # Description
byte 0 Reserved.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 27 (0x1B) Interrupted

A node indicates that a reset occurred. This can also be a node doing a warm start.

byte # Description
byte 0 Reserved.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 28 (0x1C) PreparingToSleep

A node indicates that a sleep event occurred. This can be a node going to its inactive state.

byte # Description
byte 0 Reserved.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 29 (0x1D) WokenUp

A node indicates that a wakeup event occurred. This can be a node going to it awake state.

byte # Description
byte 0 Reserved.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 30 (0x1E) Dusk

A node indicates that the system should enter its dusk state.

byte # Description
byte 0 Reserved.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 31 (0x1F) Dawn

A node indicates that the system should enter its dawn state.

byte # Description
byte 0 Reserved.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 32 (0x20) Active

A node indicates that its active.

byte # Description
byte 0 Reserved.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 33 (0x21) Inactive

A node indicates that its inactive.

byte # Description
byte 0 Reserved.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 34 (0x22) Busy

A node indicates that its busy.

byte # Description
byte 0 Reserved.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 35 (0x23) Idle

A node indicates that its idle.

byte # Description
byte 0 Reserved.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 36 (0x24) Stream Data.

A steam of information from a node can be reported with this event. This can be a serial RS- 232 channel or som other sequential stream.

byte # Description
byte 0 Sequence number which is increased by one for every new event with stream data.
byte 1-7 Stream data.

Type = 37 (0x25) Token Activity

This event is used for cards, RFID's, iButtons, GSM phones and other identification devices. The event is generated when the token device is attached/detached to/from the system. Level II has a counterpart to this event that can take more data. CLASS2.INFORMATION Type=1

Depending on the Token device type a number of this event are sent on the segment with frame index increase for each event. The total expected number can be decuced from the type.

byte # Description
byte 0 Bit 0,1 - Event code
Bit 2-7 - Token device type code
byte 1 Zone
byte 2 Subzone
byte 3 Frame index
byte 4-7 Token data
Event codes
Code Description
0 Touched and released.
1 Touched.
2 Released.
3 Reserved.
Token device type codes
Code Description
0 Unknown Token. 128-bits
1 iButton 64-bit token. 64-bits
2 RFID Token. 64-bits
3 RFID Token. 128-bits
4 RFID Token. 256-bits
5-8 Reserved.
9 ID/Credit card. 128-bits
10-15 Reserved.
16 Biometri device. 256-bits
17 Biometri device. 64-bits
18 Bluetooth device. 48-bits
19 GSM IMEI code (International Mobile Equipment Identity) AA-BBBBBB-CCCCCC-D packed in 64 bits. http://en.wikipedia.org/wiki/IMEI
20 GSM IMSI code (International Mobile Subscriber Identity) packed in 64 bits. http://en.wikipedia.org/wiki/IMSI
21 RFID Token. 40-bits
22 RFID Token. 32-bits
23 RFID Token. 24-bits
24 RFID Token. 16-bits
25 RFID Token. 8-bits
26-63 Reserved.

Type = 38 (0x26) Stream Data with zone.

A steam of information from a node can be reported with this event. This can be a serial RS- 232 channel or som other sequential stream.

byte # Description
byte 0 Zone
byte 1 Subzone
byte 2 Sequence number which is increased by one for every new event with stream data.
byte 3-7 Stream data.

Type = 39 (0x27) Confirm.

This event can be used as a general confirm event for zoned and stream data.

byte # Description
byte 0 Zone
byte 1 Subzone
byte 2 Sequence number
byte 3 Class MSB
byte 4 Class LSB
byte 5 Type MSB
byte 6 Type LSB

Type = 40 (0x28) Level Changed.

Response/confirmation from ex. a dimmer control after a dimmer command or some other unit that change a level.

byte # Description
byte 0 Relative or absolute level.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 41 (0x29) Warning

A node indicates that a warning condition occurred.

byte # Description
byte 0 User specified.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 42 (0x2A) State

A node indicates that a state change has occured. Th numerical id for the current state and the state that is about to become active is supplied.

byte # Description
byte 0 User specified.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones
byte 3 Current State
byte 4 New State

Type = 43 (0x2B) Action Trigger

A node optionally indicates that an action has beed triggered by this event.

byte # Description
byte 0 Action id.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 44 (0x2C) Sunrise

A node indicates that sunrise is detected/calculated.

byte # Description
byte 0 User specified.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 45 (0x2D) Sunset

A node indicates that sunset is detected/calculated.

byte # Description
byte 0 User specified.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 46 (0x2E) Start of record

This event is used to mark the start of a multiframe data transfer. This can typically be a GPS received which sends a train of events from one GPS record. The index byte can be used to distinguish record between each other.

byte # Description
byte 0 Index for record.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones
byte 3 Number of frames to follow or zero for not used

Type = 47 (0x2F) End of record

This event is used to mark the end of a multiframe data transfer. The index byte can be used to distinguish record between each other.

byte # Description
byte 0 Index for record.
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

Type = 48 (0x30) Pre-set active

This event is used to tell the system that a pre-set configuration is active. Usually a response from a node after a CLASS1.CONTROL, Type=28 has been received by a node.

byte # Description
byte 0 0
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones
byte 3 Code for pre-set that has been set.

Type = 49 (0x31) Detect

This event is used to tell the system that a detection of some kind has occurred.

byte # Description
byte 0 Index
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

The first byte is used as an index if a module have several channels or detectors.

Type = 50 (0x32) Overflow

This event is used to tell the system that an overflow of some kind has occurred.

byte # Description
byte 0 Index
byte 1 Zone for which event applies to (0-255). 255 is all zones
byte 2 Sub Zone for which event applies to (0-255). 255 is all sub zones

The first byte is used as an index if a module have several channels.

vscp_specification_class_20.txt · Last modified: 2010/08/19 01:55 (external edit)
Public Domain
www.chimeric.de Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0