Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
h2zero committed Jun 28, 2024
1 parent 86f1a8a commit d196c4d
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 1 deletion.
39 changes: 39 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Changelog

All notable changes to this project will be documented in this file.

## [Unreleased]

### Fixed
- min/max macros changed to fix compilation issues in some cases.
- ADC value is now volatile to prevent the compiler from optimizing it and always returning 0.
- min definition added to fix error when compiling with extended advertising enabled.
- PHY can now be correctly set when using extended advertising.
- System will no longer hang when printing to UART when it hasn't been started yet.
- Building on Windows when no DFU bin is being built will no longer cause an error.

### Changed
- Use PRIx macros to remove compiler warnings.
- Watchdog timer is now disabled by default, users should enable manually.
- pulse assembly code replace with C code to resolve linker errors on Micro:Bit V2.

### Added
- `pins_arduino.h` file to be more compatible with some libraries.
- Virtual methods `flush`, `availableForWrite` added to `Print` for compatibility.
- New constructor for `String` that takes a char* and length parameter.
- Support for nRF52810.
- Coded and/or 2M PHY for nRF52832, nRF52833, nRF52810 devices.
- Support for NimBLE core 1.5.0

## [0.1.1] - 2022-08-26

### Fixed
- Platformio build instructions.
- Fixed building Adafruit nRF52840 base boards.

### Added
- GitHub actions builds

## [0.1.0] - 2022-08-06

### INITIAL RELEASE
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@ This Arduino Core does **not** contain any BLE functionality. It has been design
* [Adafruit Feather nRF52832](https://www.adafruit.com/product/3406)
* [Ebyte E104-BT5032A-TB](https://www.ebyte.com/en/product-view-news.html?id=956)

### nRF52810
* [Generic nRF52810 MCU](https://www.nordicsemi.com/Products/nRF52810)

### nRF51
* [Generic nRF51 MCU](https://www.nordicsemi.com/eng/Products/Bluetooth-low-energy/nRF51822)
* [BBC micro:bit](https://microbit.org)
Expand All @@ -75,7 +78,7 @@ This Arduino Core does **not** contain any BLE functionality. It has been design

```ini
[env]
platform = https://github.com/h2zero/platform-n-able.git#1.0.0
platform = https://github.com/h2zero/platform-n-able.git@^1.0.0
framework = arduino
lib_deps = h2zero/NimBLE-Arduino@^1.4.0
board = ...
Expand Down

0 comments on commit d196c4d

Please sign in to comment.