1- #VSCP L1 arduino library
1+ # VSCP L1 arduino library
22
33[ ![ License] ( https://img.shields.io/badge/license-MIT-blue.svg )] ( http://choosealicense.com/licenses/mit/ )
44[ ![ Release] ( https://img.shields.io/github/release/BlueAndi/vscp-arduino.svg )] ( https://github.com/BlueAndi/vscp-arduino/releases )
13138 . [ Issues, Ideas and bugs] ( https://github.com/BlueAndi/vscp-arduino#issues-ideas-and-bugs )
14149 . [ License] ( https://github.com/BlueAndi/vscp-arduino#license )
1515
16- ##VSCP
16+ ## VSCP
1717
1818![ VSCP logo] ( http://vscp.org/images/vscp_logo.jpg )
1919
2020The Very Simple Control Protocol (VSCP), an open and free protocol for IoT/m2m automation tasks.
2121
2222More information can be found on the main site http://www.vscp.org
2323
24- ##Library
24+ ## Library
2525This is a arduino library of the VSCP software framework for level 1 devices.
2626It provides several layers according to the [ VSCP specification] ( http://www.vscp.org/docs/vscpspec/doku.php ) .
2727
2828Recommended is to connect a LED, which shows the node state.
2929
3030Mandatory 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?
3333
34- ###Define a transmit message
34+ ### Define a transmit message
3535
3636```
3737vscp_TxMessage txMsg;
3838```
3939
40- ###Prepare the transmit message
40+ ### Prepare the transmit message
4141That means to add the node nickname, the hardcoded flag, the class, the type and the priority.
4242
4343```
4444vscp.prepareTxMessage(txMsg, VSCP_CLASS_L1_INFORMATION, VSCP_TYPE_INFORMATION_ON, VSCP_PRIORITY_3_NORMAL);
4545```
4646
47- ###Add the class and type specific data.
47+ ### Add the class and type specific data.
4848
4949```
5050txMsg.data[0] = 1; // Index
@@ -53,20 +53,20 @@ txMsg.data[2] = 0; // Sub zone
5353txMsg.dataNum = 3;
5454```
5555
56- ###Send the event.
56+ ### Send the event.
5757
5858```
5959vscp.write(txMsg);
6060```
6161
62- ##MDF
62+ ## MDF
6363
6464You will find a template for the module description file here: https://github.com/BlueAndi/vscp-arduino/blob/master/mdf_template.xml
6565
6666
6767How to use it, please take a look to the [ VSCP specification] ( http://www.vscp.org/docs/vscpspec/doku.php?id=module_description_file ) .
6868
69- ##Decision Matrix
69+ ## Decision Matrix
7070
7171By default the decision matrix is enabled at page 1, offset 0 and provides about 10 rows.
7272If you need more rows, please change them in the
@@ -79,13 +79,13 @@ by defining
7979```
8080with the number of rows at the end.
8181
82- ##Examples
82+ ## Examples
8383
84- ###Generic
84+ ### Generic
8585
8686The generic example shows the basic integration of the VSCP arduino library.
8787
88- ###Seeed-Studio CAN BUS Shield
88+ ### Seeed-Studio CAN BUS Shield
8989
9090This example assume that the CAN BUS Shield from Seeed-Studio is used, as well as the corresponding CAN controller library.
9191
@@ -97,7 +97,7 @@ This example assume that the CAN BUS Shield from Seeed-Studio is used, as well a
9797Notes:
9898- If you use the CAN terminal instead of the sub-d, don't forget to wire GND too! It may work over a short distance, but no guarantee.
9999
100- ###Sparkfun CAN-BUS Shield
100+ ### Sparkfun CAN-BUS Shield
101101
102102This example assume that the CAN-BUS Shield from Sparkfun is used.
103103Because they provide no arduino library, the MCP2515 library from Frank Kienast is used.
@@ -107,7 +107,7 @@ Because they provide no arduino library, the MCP2515 library from Frank Kienast
107107
108108![ Connection to Sparkfun CAN BUS Shield] ( sparkfun_can_bus_shield.jpg )
109109
110- ##FAQ
110+ ## FAQ
111111
112112### How to install it?
113113
@@ -155,10 +155,10 @@ Enable it in the configuration VSCP/src/framework/vscp_config_overwrite.h via
155155#define VSCP_CONFIG_SILENT_NODE VSCP_CONFIG_BASE_ENABLED
156156```
157157
158- ##Issues, Ideas and bugs
158+ ## Issues, Ideas and bugs
159159
160160If you have further ideas or you found some bugs, great! Create a [ issue] ( https://github.com/BlueAndi/vscp-arduino/issues ) or if
161161you are able and willing to fix it by yourself, clone the repository and create a pull request.
162162
163- ##License
163+ ## License
164164The whole source code is published under the [ MIT license] ( http://choosealicense.com/licenses/mit/ ) .
0 commit comments