Skip to content

Commit c14708c

Browse files
committed
Readme updated with information about abstract event modules.
1 parent 9ec7754 commit c14708c

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Recommended is to connect a LED, which shows the node state.
2929

3030
Mandatory is to connect a push button, used to start the node nickname discovery. Similar as shown in the Seeed-Studio CAN-BUS Shield example.
3131

32-
## How to send a VSCP event?
32+
## How to send a VSCP event (raw)?
3333

3434
### Define a transmit message
3535

@@ -59,6 +59,27 @@ txMsg.dataNum = 3;
5959
vscp.write(txMsg);
6060
```
6161

62+
## How to send a VSCP event (abstract)?
63+
64+
### Include the abstract event module
65+
66+
```
67+
#include "framework/events/vscp_information.h"
68+
```
69+
70+
Take a look to the folder "framework/events/" to see all supported vscp event types.
71+
72+
### Call the event function
73+
74+
```
75+
// Index : 1
76+
// Zone : 0
77+
// Sub zone: 0
78+
vscp_information_sendOnEvent(1, 0, 0);
79+
```
80+
81+
No bytewise data assignment is necessary and complete done in the corresponding abstract event function. This way its more failure safe and reliable.
82+
6283
## MDF
6384

6485
You will find a template for the module description file here: https://github.com/BlueAndi/vscp-arduino/blob/master/mdf_template.xml

0 commit comments

Comments
 (0)