diff --git a/Examples/CAN_1939Sim/CAN_1939Sim.ino b/examples/CAN_1939Sim/CAN_1939Sim.ino similarity index 100% rename from Examples/CAN_1939Sim/CAN_1939Sim.ino rename to examples/CAN_1939Sim/CAN_1939Sim.ino diff --git a/Examples/CAN_BoardTest/CAN_BoardTest.ino b/examples/CAN_BoardTest/CAN_BoardTest.ino similarity index 100% rename from Examples/CAN_BoardTest/CAN_BoardTest.ino rename to examples/CAN_BoardTest/CAN_BoardTest.ino diff --git a/Examples/CAN_Example_2.ino b/examples/CAN_Example_2.ino similarity index 100% rename from Examples/CAN_Example_2.ino rename to examples/CAN_Example_2.ino diff --git a/Examples/CAN_Example_AnalogCan/CAN_Example_AnalogCan.ino.ino b/examples/CAN_Example_AnalogCan/CAN_Example_AnalogCan.ino.ino similarity index 100% rename from Examples/CAN_Example_AnalogCan/CAN_Example_AnalogCan.ino.ino rename to examples/CAN_Example_AnalogCan/CAN_Example_AnalogCan.ino.ino diff --git a/Examples/CAN_Example_Gateway/CAN_Example_Gateway.ino.ino b/examples/CAN_Example_Gateway/CAN_Example_Gateway.ino.ino similarity index 100% rename from Examples/CAN_Example_Gateway/CAN_Example_Gateway.ino.ino rename to examples/CAN_Example_Gateway/CAN_Example_Gateway.ino.ino diff --git a/Examples/OBD2_11bit_ID/OBD2_11bit_ID.ino b/examples/OBD2_11bit_ID/OBD2_11bit_ID.ino similarity index 100% rename from Examples/OBD2_11bit_ID/OBD2_11bit_ID.ino rename to examples/OBD2_11bit_ID/OBD2_11bit_ID.ino diff --git a/Examples/OBD2_29bit_ID/OBD2_29bit_ID.ino b/examples/OBD2_29bit_ID/OBD2_29bit_ID.ino similarity index 100% rename from Examples/OBD2_29bit_ID/OBD2_29bit_ID.ino rename to examples/OBD2_29bit_ID/OBD2_29bit_ID.ino diff --git a/Examples/OBD_Example_3.ino b/examples/OBD_Example_3.ino similarity index 100% rename from Examples/OBD_Example_3.ino rename to examples/OBD_Example_3.ino diff --git a/driveHome.trc b/extras/driveHome.trc similarity index 100% rename from driveHome.trc rename to extras/driveHome.trc diff --git a/driveHomeSerialLog.txt b/extras/driveHomeSerialLog.txt similarity index 100% rename from driveHomeSerialLog.txt rename to extras/driveHomeSerialLog.txt diff --git a/library.properties b/library.properties new file mode 100644 index 0000000..db952ff --- /dev/null +++ b/library.properties @@ -0,0 +1,10 @@ +name=OBD2 and CAN Acquisition +version=1.2 +author=Dan Kasamis +maintainer=Dan Kasamis +sentence=Continuous message TX/RX (DAQ applications) on Arduino DUE CAN ports. +paragraph=The scheduler supports both native DUE CAN ports and allows for one to easily implement a "free-running raw" CAN protocol or perhaps something a bit more layered such as OBD2. An OBD2 implementation is provided. +category=Communication +url=https://github.com/togglebit/ArduinoDUE_OBD_FreeRunningCAN +architectures=sam +includes=ODB2.h,DueTimer.h \ No newline at end of file diff --git a/readme.md b/readme.md index 17b23b8..2e51b91 100644 --- a/readme.md +++ b/readme.md @@ -2,8 +2,7 @@ These libraries were designed with continuous message TX/RX (DAQ applications) in mind by implementing a periodic scheduler. The scheduler supports both native DUE CAN ports and allows for one to easily implement a "free-running raw" CAN protocol -or perhaps something a bit more layered such as OBD2. An OBD2 implementation is provided, and logged CAN traffic and screen -data are provided in the repository (driveHome*.* files). +or perhaps something a bit more layered such as OBD2. An OBD2 implementation is provided. Sample, logged CAN traffic and screen data are provided in the `extras` directory (the `driveHome*.*` files). Thank you for actually reading the readme and contributing! @@ -14,13 +13,14 @@ dan@togglebit.net ## Installation What you (probably) need to do to get it working (assuming a Windows installation): -1. download Arduino IDE R 1.6.x -2. download all of the files from this repository -3. Create a new folder called "CAN" under a path C:\Users\"XXXX"\Documents\Arduino\libraries\CAN -4. Drop all files( *.c,*.h and *.ino) into the new folder (C:\Users\"XXXX"\Documents\Arduino\libraries\CAN) -5. Go to Tools->Boards->Boards Manager and download the Adruino SAM (32-bit ARM cortex-M3) boards hardware support kit -6. Once installed, go to boards select the Arduino DUE from. -7. Opening any of the examples ( *.ino) files will create a new folder. +1. Install Arduino IDE 1.6.x or newer. +2. Download all of the files from the [`due_can` repository](https://github.com/collin80/due_can) using the "Download ZIP" option. +2. Download all of the files from this repository using the "Download ZIP" option. +3. In the Arduino IDE, go to _Sketch_ -> _Include Library_ -> _Install .ZIP Library..._ and choose the ZIP file for `due_can`. +3. Do the above again, but choosing the ZIP file for this library. +5. Go to _Tools_ -> _Board: [...]_ -> _Boards Manager..._ and download the **Adruino SAM Boards (32-bit ARM Cortex-M3)** hardware support kit. +6. Once installed, go to _Tools_ -> _Board: [...]_ and select **Arduino Due**. +7. Go to _File_ -> _Examples_ -> _OBD2 and CAN Acquisition_ under the _Examples from Custom Libraries_ section to open one of the examples for this library. 8. You will now be able to verify, upload etc. ## Getting Started with Free Running CAN @@ -91,5 +91,6 @@ See: www.togglebit.net for the latest CANshield and protoshield hardware for the ### Version History +* `1.2 (2017-06-09)`: Unbundle `due_can` library. Update to support latest version of `due_can`. Add support for the Arduino IDE Library manager. * `1.1 (2015-13-09)`: * `1.0 (2014-18-03)`: Original release diff --git a/CAN_Acquisition.cpp b/src/CAN_Acquisition.cpp similarity index 100% rename from CAN_Acquisition.cpp rename to src/CAN_Acquisition.cpp diff --git a/CAN_Acquisition.h b/src/CAN_Acquisition.h similarity index 100% rename from CAN_Acquisition.h rename to src/CAN_Acquisition.h diff --git a/DueTimer.cpp b/src/DueTimer.cpp similarity index 100% rename from DueTimer.cpp rename to src/DueTimer.cpp diff --git a/DueTimer.h b/src/DueTimer.h similarity index 100% rename from DueTimer.h rename to src/DueTimer.h diff --git a/OBD2.cpp b/src/OBD2.cpp similarity index 100% rename from OBD2.cpp rename to src/OBD2.cpp diff --git a/OBD2.h b/src/OBD2.h similarity index 100% rename from OBD2.h rename to src/OBD2.h