Welcome

OpenLcbCLib - create OpenLcb (or NMRA LCC) node firmware in C easily.

Implementation Guide

OpenLCB C Library Implementation Guide — In-depth documentation covering architecture, state machines, protocol handlers, data flow, and extending the library.

Getting Started Guides

Quick Start Guide — Get an OpenLCB/LCC node running on ESP32 with Arduino IDE in minutes. Covers hardware wiring, project setup from the BasicNode demo, Node IDs, and uploading your first sketch.

Developer Guide — In-depth walkthrough of the Node Wizard, project file structure, driver implementation, callbacks, events, configuration memory, and all supported platforms.

Node Wizard

Node Wizard — Browser-based tool for configuring OpenLCB nodes. Generates the user configuration files, CDI/FDI descriptors, and application entry point for your target platform. No installation or internet connection required.

CDI Editor

CDI Editor — Standalone browser-based editor for creating and editing Configuration Description Information (CDI) XML descriptors. Useful for updating CDI on existing nodes without running the full Node Wizard.

License

All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.