Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
RobTillaart committed Jun 27, 2023
1 parent ea80a48 commit 4189b41
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 7 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).

## [0.3.8] - 2023-06-18
- add **void burnSetting()** improvements from #38
- add sketches to burn settings (use with care!)
- use with care
- add sketches to burn settings (use with care!)
- minor edits.


Expand Down
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -394,29 +394,39 @@ Please read datasheet for details.
| 6-7 | | not used | |


## Make configuration persistent.
## Make configuration persistent. BURN

**USE AT OWN RISK**
#### Read burn count

Please read datasheet **twice** as these changes are not reversible.
- **uint8_t getZMCO()** reads back how many times the ZPOS and MPOS
registers are written to permanent memory.
You can only burn a new Angle 3 times to the AS5600, and only 2 times for the AS5600L. This function is safe as it is readonly.


#### BURN function

The burn functions are used to make settings persistent.
These burn functions are permanent, therefore they are commented in the library.
Please read datasheet twice, before uncomment them.

**USE AT OWN RISK**

Please read datasheet **twice** as these changes are not reversible.

The risk is that you make your AS5600 / AS5600L **USELESS**.

**USE AT OWN RISK**

- **uint8_t getZMCO()** reads back how many times the ZPOS and MPOS
registers are written to permanent memory.
You can only burn a new Angle 3 times to the AS5600, and only 2 times for the AS5600L.
These are the two "unsafe" functions:
- **void burnAngle()** writes the ZPOS and MPOS registers to permanent memory.
You can only burn a new Angle maximum **THREE** times to the AS5600
and **TWO** times for the AS5600L.
- **void burnSetting()** writes the MANG register to permanent memory.
You can write this only **ONE** time to the AS5600.

Some discussion about burning see issue #38
(I have no hands on experience with this functions)

**USE AT OWN RISK**


Expand Down

0 comments on commit 4189b41

Please sign in to comment.