From 0fbe2a13d1432840049a36e8d9b646f406eaa855 Mon Sep 17 00:00:00 2001 From: Alex Shepherd Date: Tue, 6 Mar 2018 18:48:43 +1300 Subject: [PATCH] Changed version to 2.0.0 Added more detail to the README.md NOT READY FOR PRODUCTION YET, needs more checking and change to provide some backwards compatibility for call-backs that had been removed --- README.md | 4 ++++ library.properties | 6 +++--- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9bdbea0..d111399 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ # NmraDcc NMRA Digital Command Control (DCC) Library +This library allows you to interface to a NMRA DCC track signal and receive DCC commands. + +The library currently supports the AVR ATTiny84/85 & ATMega88/168/328/32u4 and Teensy 3.x using the INT0/1 Hardware Interrupt and micros() ONLY and no longer uses Timer0 Compare Match B, which makes it much more portable to other platforms. + **Warning** as of version 1.4.4 support has been removed for the following two call-back functions, which will cause your sketch to silently stop working: extern void notifyDccAccState( uint16_t Addr, uint16_t BoardAddr, uint8_t OutputAddr, uint8_t State ) diff --git a/library.properties b/library.properties index f31fc11..c81337b 100644 --- a/library.properties +++ b/library.properties @@ -1,9 +1,9 @@ name=NmraDcc -version=1.4.4 +version=2.0.0 author=Alex Shepherd, Wolfgang Kuffer, Geoff Bunza, Martin Pischky, Franz-Peter Müller, Sven (littleyoda) maintainer=Alex Shepherd sentence=Enables NMRA DCC Communication -paragraph=This library allows you to interface to a NMRA DCC track signal and receive DCC commands. The library currently supports the AVR ATTiny84/85 & ATMega88/168/328/32u4 and Teensy 3.x using the INT0/1 Hardware Interrupt and micros() ONLY and no longer uses Timer0 Compare Match B, which makes it much more portable to other platforms. ALSO BEWARE as of version 1.4.4 support for the call-back functions notifyDccAccState() and notifyDccSigState() has been removed, please check and update your sketches, as they will silently fail. +paragraph=This library allows you to interface to a NMRA DCC track signal and receive DCC commands. The library currently supports the AVR ATTiny84/85 & ATMega88/168/328/32u4 and Teensy 3.x using the INT0/1 Hardware Interrupt and micros() ONLY and no longer uses Timer0 Compare Match B, which makes it much more portable to other platforms. WARNING as of version 1.4.4 support for the call-back functions notifyDccAccState() and notifyDccSigState() has been removed, please check and update your sketches, as they will silently fail. category=Communication -url=http://mrrwa.org/dcc-decoder-interface/ +url=https://github.com/mrrwa/NmraDcc architectures=avr,esp8266,STM32F1