Skip to content

Commit

Permalink
Readme updated with information about abstract event modules.
Browse files Browse the repository at this point in the history
  • Loading branch information
BlueAndi committed Jan 3, 2019
1 parent 9ec7754 commit c14708c
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Recommended is to connect a LED, which shows the node state.

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.

## How to send a VSCP event?
## How to send a VSCP event (raw)?

### Define a transmit message

Expand Down Expand Up @@ -59,6 +59,27 @@ txMsg.dataNum = 3;
vscp.write(txMsg);
```

## How to send a VSCP event (abstract)?

### Include the abstract event module

```
#include "framework/events/vscp_information.h"
```

Take a look to the folder "framework/events/" to see all supported vscp event types.

### Call the event function

```
// Index : 1
// Zone : 0
// Sub zone: 0
vscp_information_sendOnEvent(1, 0, 0);
```

No bytewise data assignment is necessary and complete done in the corresponding abstract event function. This way its more failure safe and reliable.

## MDF

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

0 comments on commit c14708c

Please sign in to comment.