VLCB-Arduino
VLCB-Arduino
This project implements an Arduino library for VLCB running over CAN bus. VLCB is an extension of CBUS. It fascilitates development of new VLCB modules as Arduino sketches.
CBUS(R) is a registered trademark of Dr. Michael Bolton.
This VLCB library code is based on a CBUS library created by Duncan Greenwood and extended by members of MERG. See below under Credits.
Full documentation is available in https://svenrosvall.github.io/VLCB-Arduino
Developing a sketch for a VLCB module
This library is intended for module developers to make it as easy as possible to create new VLCB module types. You don’t need to understand the internals of the library to use it. Refer to the sketch development document for more information on how to develop your own VLCB module.
Library development
This VLCB library is built with an object-oriented architecture
described in the design document.
It uses a Controller object for the core tasks, a Configuration
object for storing module configurations and a set of services.
The Full API documentation describes all of these
objects.
If you want to share improvements please create a branch of the respository and create a pull request.
File Structure
This library consists of the following sub-directories and files:
- src
- This where the library source code resides.
- examples
- A few example sketches that illustrate how this library can be used. See description of these.
- docs
- Design documents for the library.
- Arduino
- A set of stub header files to allow the library to be compiled outside the Arduino IDE.
- test
- Unit tests for the library. See its README.
- library.properties
- Properties for exporting this library to the Arduino library manager.
- CmakeLists.txt
- CMake project definition. CMake is used for building the library outside the Arduino IDE and running unit tests.
Dependencies
Note that this library depends on a number of other libraries which must also be downloaded and included in the sketch:
- Streaming - C++ style output
Hardware
This library only contains CAN transport over serial communication which does not require any external dependencies. Implementation using specific CAN harddware are provided in separate libraries.
Supports for the MCP2515 and MCP2565 CAN controller ICs via the ACAN2515 library is provided in the repository VCAN2515.
Support for Raspberry Pi Pico boards is provided by Martin Da Costa in the repository VCAN2040.
Getting help and support
If you have any questions or suggestions please contact the library maintainers by email to vlcb@rosvall.ie or create an issue in GitHub.
Credits
- Duncan Greenwood - Created the CBUS library for Arduinos which this VLCB library is based on.
- Sven Rosvall - Developer. Converted the CBUS library into this code base.
- Martin Da Costa - Developer
- John Fletcher - Contributor
- Chris Andrews - Contributor
- David Ellis - Contributor
- Bruno Rocci - Contributor to the CBUS library
License
The code contained in this repository and the executable distributions are licensed under the terms of the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
If you have questions about licensing this library please contact license@rosvall.ie