Skip to content

Commit 48ec1bb

Browse files
committed
reorg the upgrade notice
1 parent c1510c6 commit 48ec1bb

File tree

1 file changed

+36
-32
lines changed

1 file changed

+36
-32
lines changed

README.md

Lines changed: 36 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -18,38 +18,9 @@ The XM125 boasts an impressive range of up to 20 meters, allowing you to create
1818

1919
Looking for the board that matches this library - pick up a [SparkFun Pulsed Coherent Radar Sensor - Acconeer XM125 (Qwiic)](https://www.sparkfun.com/sparkfun-pulsed-coherent-radar-sensor-acconeer-xm125-qwiic.html) at <www.sparkfun.com>.
2020

21-
## Upgrading to Version 2.\* from Version 1.\*
22-
23-
Version 2.0+ of this library is not compatible with Version 1.* implementations/use. For Version 2.0, the single class defined by the library, `SfeXM125`, was divided into two distinct classes for schemantic clarity and code simplification.
24-
25-
### Version 2.0 Changes
26-
27-
#### Classes
28-
29-
The device single class was devided into two classes - one for each specific I2C application that the Acconeer XM125 can run. These classes are:
30-
31-
* SparkFunXM125Distance - Used when the XM125 is running the ***Distance*** application
32-
* SparkFunXM125Presence - Used when the XM125 is running the ***Presence*** application
33-
34-
#### Method Names
35-
36-
Additionally, the method naming pattern for each application was simplified - removing *Distance* and *Presence* from method names.
37-
38-
### Supporting Version 1.* Implementations
39-
40-
To simplify the transition from an application written using the Version 1.* library, two compatiblity classes are provided:
41-
42-
* SparkFunXM125DistanceV1 - Used when the XM125 is running the ***Distance*** application
43-
* SparkFunXM125PresenceV1 - Used when the XM125 is running the ***Presence*** application
44-
45-
These classes implement the version 1.*method names for the library, to minimize the porting requirements when upgrading to Version 2.*.
46-
47-
To upgrade to Version 2.0 of the library, perform one of the following:
48-
49-
* If the Acconeer XM125 is running the I2C Distance Application: Rename the device class from `SfeXM125` to `SparkFunXM125DistanceV1`
50-
* If the Acconeer XM125 is running the I2C Presence Application: Rename the device class from `SfeXM125` to `SparkFunXM125PresenceV1`
51-
52-
Once the class name is changed, your application is ready to use version 2.* of this library.
21+
> [!NOTE]
22+
>
23+
> If upgrading from using Version 1.* of this library, some changes are required before moving to Version 2.0+. The detals of this are outlined in the section titled [Upgrading to Version 2 from Version 1](#upgrading-to-version-2-from-version-1) later in this document.
5324
5425
## Functionality
5526

@@ -97,3 +68,36 @@ The Hookup Guide for the SparkFun Qwiic Soil Moisture Sensor is available [here]
9768
This product is ***open source***!
9869

9970
This product is licensed using the [MIT Open Source License](https://opensource.org/license/mit).
71+
72+
## Upgrading to Version 2 from Version 1
73+
74+
Version 2.0+ of this library is not compatible with Version 1.* implementations/use. For Version 2.0, the single class defined by the library, `SfeXM125`, was divided into two distinct classes for schemantic clarity and code simplification.
75+
76+
### Version 2.0 Changes
77+
78+
#### Classes
79+
80+
The device single class was devided into two classes - one for each specific I2C application that the Acconeer XM125 can run. These classes are:
81+
82+
* SparkFunXM125Distance - Used when the XM125 is running the ***Distance*** application
83+
* SparkFunXM125Presence - Used when the XM125 is running the ***Presence*** application
84+
85+
#### Method Names
86+
87+
Additionally, the method naming pattern for each application was simplified - removing *Distance* and *Presence* from method names.
88+
89+
### Supporting Version 1.* Implementations
90+
91+
To simplify the transition from an application written using the Version 1.* library, two compatiblity classes are provided:
92+
93+
* SparkFunXM125DistanceV1 - Used when the XM125 is running the ***Distance*** application
94+
* SparkFunXM125PresenceV1 - Used when the XM125 is running the ***Presence*** application
95+
96+
These classes implement the version 1.*method names for the library, to minimize the porting requirements when upgrading to Version 2.*.
97+
98+
To upgrade to Version 2.0 of the library, perform one of the following:
99+
100+
* If the Acconeer XM125 is running the I2C Distance Application: Rename the device class from `SfeXM125` to `SparkFunXM125DistanceV1`
101+
* If the Acconeer XM125 is running the I2C Presence Application: Rename the device class from `SfeXM125` to `SparkFunXM125PresenceV1`
102+
103+
Once the class name is changed, your application is ready to use version 2.* of this library.

0 commit comments

Comments
 (0)