Skip to content

Commit

Permalink
Updates for the library release 1.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
krzychb committed Jan 23, 2022
1 parent 96891c2 commit 4f71785
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 10 deletions.
6 changes: 3 additions & 3 deletions examples.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
## Examples

The following example Arduino sketches (*.ino) are available with this library:
The following example Arduino sketches (`*.ino`) are available with this library:

1. [SimpleCrash](https://github.com/krzychb/EspSaveCrash/blob/master/examples/SimpleCrash/SimpleCrash.ino) - trigger sample exceptions and show them on a serial monitor.
2. [ExtendedCrashTester](https://github.com/krzychb/EspSaveCrash/blob/master/examples/ExtendedCrashTester/ExtendedCrashTester.ino) - extended version of SimpleCrash above. It allows triggering additional sample exceptions.
3. [RemoteCrashCheck](https://github.com/krzychb/EspSaveCrash/blob/master/examples/RemoteCrashCheck/RemoteCrashCheck.ino) - check the list and details of saved exceptions remotely with web browser.
4. [WebServerCrashCheck](https://github.com/krzychb/EspSaveCrash/blob/master/examples/WebServerCrashCheck/WebServerCrashCheck.ino) - save crash data to user buffer to check it remotely with web browser using ESP8266WebServer. Contributed by [brainelectronics](http://www.brainelectronics.de/).

To use examples below, first you need to [install](readme.md#installation) the [EspSaveCrash](https://github.com/krzychb/EspSaveCrash) library on your PC.
To use examples below, first you need to [install](README.md#installation) the [EspSaveCrash](https://github.com/krzychb/EspSaveCrash) library on your PC.


## Table of Contents
Expand Down Expand Up @@ -173,7 +173,7 @@ Once module connects to the network, after opening provided IP in a web browser,

## Library Configuration

Crash data is saved using the [EEPROM](https://github.com/esp8266/Arduino/blob/master/doc/libraries.md#eeprom) library that is provided together with [esp8266 / Arduino](https://github.com/esp8266/Arduino) core.
Crash data is saved using the [EEPROM](https://arduino-esp8266.readthedocs.io/en/latest/libraries.html#eeprom) library that is provided together with [esp8266 / Arduino](https://github.com/esp8266/Arduino) core.

If you like to change flash memory space reserved for storing crash information use class constructor. The maximum value is `4096` (`0x1000`) bytes as defined for the [EEPROM](https://github.com/esp8266/Arduino/blob/master/doc/libraries.md#eeprom) library.

Expand Down
2 changes: 1 addition & 1 deletion library.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "EspSaveCrash",
"version": "1.2.0",
"version": "1.3.0",
"keywords": "crash, exception, restart, software WDT, diagnostics",
"description": "Automatically saves exception details and stack trace to flash in case of ESP8266 crash.",
"repository":
Expand Down
2 changes: 1 addition & 1 deletion library.properties
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name=EspSaveCrash
version=1.2.0
version=1.3.0
author=Krzysztof Budzynski <[email protected]>
maintainer=Krzysztof Budzynski <[email protected]>
sentence=Automatically saves exception details and stack trace to flash in case of ESP8266 crash.
Expand Down
2 changes: 1 addition & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ krzychb
* Thanks to contribution by [Juan L. Pérez Díez](https://github.com/jlpdiez) the library accepts offset and size parameters passed into the constructor.
* With kind contribution by [brainelectronics](http://www.brainelectronics.de/) the crash log can be stored to char buffer for more convenient use with a web server.
* [Oxan van Leeuwen](https://github.com/oxan) brought nice code improvements, intoduced size buffer check to prevent the buffer overflow and fixed some spelling errors.

* Thanks to [Byron Johnson](https://github.com/bwjohns4) the library now allows users who are already using EEPROM to continue in an intuitive way and not have this library close the EEPROM.

## License

Expand Down
4 changes: 2 additions & 2 deletions src/EspSaveCrash.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
Repository: https://github.com/krzychb/EspSaveCrash
File: EspSaveCrash.cpp
Revision: 1.2.1
Date: 25-Apr-2020
Revision: 1.3.0
Date: 23-Jan-2022
Author: krzychb at gazeta.pl
Copyright (c) 2016 Krzysztof Budzynski. All rights reserved.
Expand Down
4 changes: 2 additions & 2 deletions src/EspSaveCrash.h
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
Repository: https://github.com/krzychb/EspSaveCrash
File: EspSaveCrash.h
Revision: 1.1.0
Date: 18-Aug-2016
Revision: 1.3.0
Date: 23-Jan-2022
Author: krzychb at gazeta.pl
Copyright (c) 2016 Krzysztof Budzynski. All rights reserved.
Expand Down

0 comments on commit 4f71785

Please sign in to comment.