Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare documentation for v5.0.0 release #980

Merged
merged 3 commits into from
Nov 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ us know (creating a GitHub issue is probably the best way for that).

### PDF/Word Documentation

The `doc` directory contains [LMIC-v4.1.0.pdf](doc/LMIC-v4.1.0.pdf), which documents the library APIs and use. It's based on the original IBM documentation, but has been adapted for this version of the library. However, as this library is used for more than Arduino, that document is supplemented by Arduino-specific details in this document.
The `doc` directory contains [LMIC-v5.0.0.pdf](doc/LMIC-v5.0.0.pdf), which documents the library APIs and use. It's based on the original IBM documentation, but has been adapted for this version of the library. However, as this library is used for more than Arduino, that document is supplemented by Arduino-specific details in this document.

### Adding Regions

Expand Down Expand Up @@ -1023,7 +1023,7 @@ function uflt12f(rawUflt12)
- Fix additional warnings on non-ARM platforms ([#791](https://github.com/mcci-catena/arduino-lmic/issues/791), thanks [@d-a-v](https://github.com/d-a-v)).
- Allow application to set the value to be used in `DeviceStatusAns` MAC messages ([#576](https://github.com/mcci-catena/arduino-lmic/issues/576) and [#560](https://github.com/mcci-catena/arduino-lmic/issues/560), thanks to [@altishchenko](https://github.com/altishchenko)).
- Minor adjustments to the compliance sketch ([#800](https://github.com/mcci-catena/arduino-lmic/issues/576)).
- Update the LMIC reference manual to `LMIC-v4.1.0.pdf`.
- Update the LMIC reference manual to `LMIC-v5.0.0.pdf`.

- v4.0 is a major release; changes are significant enough to be "likely breaking". It includes the following changes.

Expand Down
Binary file removed doc/LMIC-v4.1.0-redline.pdf
Binary file not shown.
Binary file removed doc/LMIC-v4.1.0.docx
Binary file not shown.
Binary file removed doc/LMIC-v4.1.0.pdf
Binary file not shown.
Binary file added doc/LMIC-v5.0.0-redline.pdf
Binary file not shown.
Binary file added doc/LMIC-v5.0.0.docx
Binary file not shown.
Binary file added doc/LMIC-v5.0.0.pdf
Binary file not shown.
4 changes: 2 additions & 2 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ This directory contains documentation on the use and implementation of the LMIC.

## Usage documentation

- [`LMIC-v3.3.0.pdf`](./LMIC-v3.3.0.pdf): API documentation on the LMIC as of 3.3.0.
- [`LMIC-v3.3.0-redline.pdf`](./LMIC-v3.3.0-redline.pdf): changes in the document since last update, marked up by Litera Workshare Compare.
- [`LMIC-v5.0.0.pdf`](./LMIC-v5.0.0.pdf): API documentation on the LMIC as of 5.0.0.
- [`LMIC-v5.0.0-redline.pdf`](./LMIC-v5.0.0-redline.pdf): changes in the document since last update, marked up by Litera Workshare Compare.

## Background information

Expand Down
2 changes: 1 addition & 1 deletion src/lmic/hal.h
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ void lmic_hal_failed (const char *file, u2_t line);
* set a custom hal failure handler routine. The default behaviour, defined in
* lmic_hal_failed(), is to halt by looping infintely.
*/
void lmic_hal_set_failure_handler(const lmic_hal_failure_handler_t* const);
void lmic_hal_set_failure_handler (lmic_hal_failure_handler_t*);

/*
* get the calibration value for radio_rssi
Expand Down
Loading