Skip to content

Commit

Permalink
Prepare release v1.6
Browse files Browse the repository at this point in the history
  • Loading branch information
jfpoilpret committed Nov 21, 2020
1 parent 9a806a1 commit 8841710
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Latest News
===========

FastArduino v1.5 has been released on 18th January 2020.
The implemented enhancements are listed [here](https://github.com/jfpoilpret/fast-arduino-lib/milestone/7?closed=1).
Please note that this version breaks compatibility on some API, as described in further detail in the [release notes](https://github.com/jfpoilpret/fast-arduino-lib/releases/tag/v1.5).
FastArduino v1.6 has been released on 22nd November 2020.
The implemented enhancements are listed [here](https://github.com/jfpoilpret/fast-arduino-lib/milestone/8?closed=1).
Please note that this version breaks compatibility on I2C API, as described in further detail in the [release notes](https://github.com/jfpoilpret/fast-arduino-lib/releases/tag/v1.6).

FastArduino
===========
Expand Down Expand Up @@ -51,8 +51,8 @@ In the current version, the project covers almost all features; a few missing, l
What the library already has:

- General utilities (queues, linked lists, busy loop delays)
- LifeCycle management support to keep track of moving or destroyed objects (preview on Git master, to be released in **v1.6**)
- "Future" support for asynchronous computation (preview on Git master, to be released in **v1.6**)
- LifeCycle management support to keep track of moving or destroyed objects
- "Future" support for asynchronous computation
- Fast IO support: template-based, optimized for speed and size
- Analog Digital Conversion support (in Single Conversion mode)
- Analog Comparator support
Expand All @@ -70,7 +70,7 @@ What the library already has:
- Pin Change Interrupt (PCI) handling
- External Pin Interrupt handling
- SPI master support
- I2C master support (synchronous mode and asynchronous mode (preview on Git master, to be released in **v1.6**) for ATmega MCU)
- I2C master support with both synchronous and asynchronous modes supported (asynchronous only for ATmega MCU)
- Hardware UART support (for MCU that support it, ie not for ATtiny)
- Software UART support (for all MCU)
- "C++ like" Input/Output streams (used by UART implementations)
Expand Down Expand Up @@ -139,14 +139,14 @@ The roadmap of next activities and new supported features is the following:
- [Milestone v1.3](https://github.com/jfpoilpret/fast-arduino-lib/milestone/5?closed=1) (released on 1.09.2019)
- [Milestone v1.4](https://github.com/jfpoilpret/fast-arduino-lib/milestone/6?closed=1) (released on 22.09.2019)
- [Milestone v1.5](https://github.com/jfpoilpret/fast-arduino-lib/milestone/7?closed=1) (released on 18.01.2020)
- [Milestone v1.6](https://github.com/jfpoilpret/fast-arduino-lib/milestone/8) (30.11.2020)
- [Milestone v1.6](https://github.com/jfpoilpret/fast-arduino-lib/milestone/8?closed=1) (released on 22.11.2020)
- [Milestone v1.7](https://github.com/jfpoilpret/fast-arduino-lib/milestone/9) (31.12.2020)
- [Milestone v2.0](https://github.com/jfpoilpret/fast-arduino-lib/milestone/3) (undefined date)
- [Later](https://github.com/jfpoilpret/fast-arduino-lib/issues?q=is%3Aopen+is%3Aissue+no%3Amilestone)

Documentation - no milestones
-----------------------------
- Document how to add support for other boards in Tutorial (late 2020)
- Document how to add support for other boards in Tutorial (1st half 2021)

Milestones dates are "best effort" and may change based on contributors' availability.

Expand Down
33 changes: 33 additions & 0 deletions basedoc/Release-process.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,39 @@ Release procedure
9. Official release in github
10. Close milestone in github

FastArduino 1.6 release

I am happy to announce the 7th major release of FastArduino platform.

Since release 1.5 (January 2020), the main changes are listed [there](https://github.com/jfpoilpret/fast-arduino-lib/milestone/8?closed=1).

This release brings the following improvements:
- New API for "future" concept
- New API for "lifecycle" concept and dynamic proxies
- Global rework of the I2C support in order to allow asynchronous handling (on ATmega architecture only)
- Small improvements to Timer API
- Slight improvements to API of GPIO, PCI and PWM
- New "test" namespace with a few helper function used by some FastArduino test examples

Note that I2C API changes are unfortunately not fully compatible with existing programs:
1. If your program uses FastArduino provided I2C devices, then small adaptations will be needed. All examples have been adapted to show these changes.
2. If you have defined your own I2C device support, then you are out of luck: you will have to rewrite most of it, as I2C device API is now based on the new "future" concept.

Other API changes shall have no impact on existing programs.

Known bugs and requests for enhancements: https://github.com/jfpoilpret/fast-arduino-lib/issues

The platform is well documented:

- a [tutorial](http://jfpoilpret.github.io/fast-arduino-lib/tutorial.html) allows developers to discover and learn the platform step by step
- FastArduino core API is documented through doxygen and documentation is published [here](http://jfpoilpret.github.io/fast-arduino-lib/)
- FastArduino comes with many examples covering all supported features and devices

I hope you'll enjoy playing with FastArduino platform; please submit enhancements you would like
to see in future versions or report issues you may discover.



FastArduino 1.5 release

I am happy to announce the 6th major release of FastArduino platform.
Expand Down

0 comments on commit 8841710

Please sign in to comment.