Skip to content

Commit 6dfc8cf

Browse files
authored
documentation (#17)
* update documentation about 118 version differences and its calibration risks.
1 parent 5e83ae1 commit 6dfc8cf

File tree

1 file changed

+34
-5
lines changed

1 file changed

+34
-5
lines changed

README.md

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,46 @@ This is done to minimize interference with the communication of other devices.
2828
The reset clock speed can be changed with **setI2CResetSpeed()** e.g. to 200 or 400 KHz.
2929

3030

31-
## Version problem?
31+
## Version 118 problems
3232

3333
The library can request the version with **getSensorVersion()**.
3434
My devices all report version 117 and this version is used to develop / test this library.
35-
There are devices reported with version 118 which only support the **PPB** and not the **ugM3** mode.
35+
There are devices reported with version 118 which behave differently.
36+
37+
38+
### ugM3 not supported
39+
40+
See - https://github.com/RobTillaart/AGS02MA/issues/11
41+
42+
The version 118 seems only to support the **PPB** and not the **ugM3** mode.
3643
It is unclear if this is an incident, bug or a structural change in the firmware.
3744

38-
So if you encounter problems with setting the mode, let me know.
39-
Also if you have a working device, not being version 117 or 118 let me know too.
45+
If you encounter similar problems with setting the mode (any version), please let me know.
46+
That will help indicating if this is a "structural change" or incident.
47+
48+
49+
### Calibrate problem!
50+
51+
See - https://github.com/RobTillaart/AGS02MA/issues/13
52+
53+
In this issue a problem is reported with a version 118 sensor.
54+
The problem exposed itself after running the calibration sketch (command).
55+
The problem has been confirmed by a 2nd version 118 sensor.
56+
Additional calibration runs did not fix the problem.
57+
Version 117 seem to have no problems with calibration.
58+
59+
**Advice**: do **NOT** calibrate a version 118.
60+
61+
Note: the version 0.2.0 determines the version in the calibration function so
62+
it won't calibrate any non 117 version.
63+
64+
65+
66+
### Please report your experiences.
4067

41-
See also - https://github.com/RobTillaart/AGS02MA/issues/11
68+
If you have a AGS20MA device, version 117 or 118 or other,
69+
please let me know your experiences
70+
with the sensor and this (or other) library.
4271

4372

4473
## Interface

0 commit comments

Comments
 (0)