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

v3.1.0 ready for release #119

Merged
merged 32 commits into from
Mar 26, 2018
Merged

v3.1.0 ready for release #119

merged 32 commits into from
Mar 26, 2018

Conversation

Marzogh
Copy link
Owner

@Marzogh Marzogh commented Mar 26, 2018

Pull request details

  • Please check if the PR fulfills these requirements
  • The commit message/s explain/s all the changes clearly
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
  • Bug fix
  • Added feature
  • Documentation update
  • Other - Please explain here: Version update
  • What is the current behavior? (You can also link to an open issue here)

As in v3.0.1

  • What is the new behavior (if this is a feature change)?

As in v3.1.0

  • Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

No

  • Other information:

per1234 and others added 28 commits February 9, 2018 15:47
The Arduino IDE currently requires the use of a tab separator between the name and identifier. Without this tab the keyword is not highlighted.

Reference:
https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification#keywords
…memory boundary - when rolling over from address '_chip.capacity' to address '0x00' - has been fixed. In previous versions this caused issues with writing complex data structures across the memory boundary and led to many _writeErrorCheck() failures. Fixes issue #112

--> A new function - 'flash.eraseSection(address, size)' - has been intrduced in this version. When a user requires a large and variable (between writes) amount of data to be written to the flash memory on the fly and to have the correct amount of space erased to fit the data, this function will automatically calculate and erase the right amount of space to fit the data. Please note that if the the amount of data being written is consistently the same size, the pre-existing 'flash.eraseSector()', 'flash.eraseBlock32K()' and 'flash.eraseBlock64K()' functions will operate a lot faster.
…e complex structs that contain nested structs
Use correct separator in keywords.txt
…eywords.txt file i line with the Arduino Library standards
The Arduino IDE currently requires the use of a tab separator between the name and identifier. Without this tab the keyword is not highlighted.

Reference:
https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification#keywords

All tabs appear to have been inadvertently changed to spaces by e8c4ae1
Use correct separator in keywords.txt
Update ISSUE_TEMPLATE to include details of how to troubleshoot with FlashDiagnostics.ino. Also included warning in the beginning that all issues must be submitted according to the template
Update PULL_REQUEST_TEMPLATE to warning in the beginning that all PRs must be submitted according to the template
…t it is checked during erase functions as well.

Updated Changes.log to reflect changes made.
…g structs is now as stable as other functions are. Fixes #106
…e can be dismissed by commenting out the instance of in SPIFlash.h. Please refer to the Readme file for further details.

- All compilation-time, non-critical errors have been fixed.
Minor fix in API description of getManID()
@Marzogh Marzogh added enhancement An enhancement to the library's function is proposed bugfix Fixes an existing bug in the current version of the code labels Mar 26, 2018
@Marzogh Marzogh added this to the v3.1.0 milestone Mar 26, 2018
@Marzogh Marzogh self-assigned this Mar 26, 2018
@Marzogh Marzogh merged commit f3a76a0 into stable Mar 26, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bugfix Fixes an existing bug in the current version of the code enhancement An enhancement to the library's function is proposed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants