Skip to content

Commit 834c327

Browse files
committed
Updated readme to reflect name change
- Changed name to differentiate from the original parent now that this fork has been split. - Tweaked some text to improve readability.
1 parent 04e0e89 commit 834c327

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,26 @@
1-
CmdrArduino
1+
DCCCommander
22
===========
33

4-
CmdrArduino is an embedded library written in C(++) that provides the foundation for implementing an NMRA DCC command station.
4+
DCCCommander is an embedded library written in C/C++ that provides the foundation for implementing an NMRA DCC command station.
55

6-
CmdrArduino presents classes and methods for, among other things, setting a locomotive’s speed, activating functions, switching turnouts, and programming DCC decoders. CmdrArduino translates these commands into DCC packets. The packets are carefully prioritzed, and CmdrArduino keeps track of packets that require repeating in the background. An interrupt service routine attached to TIMER1 (AVR) or MCPWM0 (ARM) takes these packets and injects the highest priority packet into the precision DCC waveform. This signal is suitable for amplification with your booster/power station. Please note that the Arduino outputs are not themselves capable of driving trains directly.
6+
DCCCommander provides functions for various train and accessory related settings, including: setting a locomotive’s speed, activating functions, switching turnouts, and programming DCC decoders.
77

8-
Currently, CmdrArduino supports various Arduino devices including atmega168/328 variants, as well as the Yun and attiny.
8+
DCCCommander translates these commands into NMRA-compatible DCC packets for transmitting over the tracks. Packets are prioritzed dependent on their type and DCCCommander keeps track of packets that require long-term repeating in the background.
9+
10+
An interrupt service routine attached to TIMER1 (AVR) or MCPWM0 (ARM) takes these packets and injects the highest priority packet into the precision DCC waveform. This signal is suitable for amplification with your booster/power station/motor-controller.
11+
12+
**Please note that the Arduino outputs are not capable of driving trains directly.**
13+
14+
Currently, DCCCommander supports various Arduino devices including atmega168/328 variants, as well as the Yun and attiny.
915

1016
Installation
1117
------------
1218

1319
To install, see the general instructions for Arduino library installation here:
1420
http://arduino.cc/en/Guide/Environment#libraries
1521

22+
23+
Origins
24+
-------
25+
26+
DCCCommander is a heavily modified fork to CmdrArduino - https://github.com/Railstars/CmdrArduino

0 commit comments

Comments
 (0)