Skip to content

Commit 2267213

Browse files
M65649M65649
committed
MCU8MASS-2371 Update changelog
1 parent c724eb1 commit 2267213

File tree

1 file changed

+133
-99
lines changed

1 file changed

+133
-99
lines changed

‎CHANGELOG.md‎

Lines changed: 133 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -1,96 +1,105 @@
1-
# 1.0.0
2-
3-
* Initial Release
4-
5-
# 1.1.0
1+
# 1.3.8
62

73
## Features
84

9-
* Added sensor driver shutdown to lower power examples
10-
* Refactored sandbox to use modulo instead of masking
11-
* Added a simple CLI for the sandbox
5+
* Azure support with accompanying example sketch and provisioning
6+
* Flash string support for the log module and the sequans controller with the `F()` macro
7+
* A plant monitoring system example sketch is now included in the library
8+
* The HttpClient now also reports curl status codes for better error handling
129

13-
## Bugfixes
10+
## Optimizations
1411

15-
* Fixed a bug where the board buttons were disabled during sleep, and could not wake up the MCU
16-
* Removed configuring button as input again after not disabling it
17-
* Fixed a bug where flow control was not correctly applied when the receive buffer was full. This particularly affected the sandbox.
12+
* The library now has a significantly lower RAM usage due to use of strings stored in flash rather than in RAM
1813

19-
# 1.1.1
14+
## Changes
15+
16+
* `MqttClient.begin` is now blocking (within the timeout) and the callback registered with `MqttClient.onConnect` is deprecated and won't be called. This is to be able to capture error messages during the MQTT connection.
2017

2118
## Bugfixes
2219

23-
* Fixes a bug where LTE connectivity in sandbox was not reconnecting
24-
* Added temporarily work around for TLS certificate verification in certain regions
20+
* The provisioning sketch now supports a chain of certificates
21+
* Fixes some missing dependencies for the examples
2522

26-
# 1.1.2
2723

28-
## Features
29-
* Add NTP synchronization in Lte.begin() if modem clock is not set
24+
# 1.3.7
3025

3126
## Bugfixes
32-
* Fixes a bug for TLS certificate verification in certain regions
33-
* Fixes a bug where the power save functionality would not terminate
34-
* Reduce time used for querying for operator
27+
* Fix a bug where a disconnect from the network whilst being connected to a MQTT broker would cause the board to not respond
3528

36-
# 1.1.3
37-
38-
## Bugfixes
29+
# 1.3.6
3930

40-
* Fixes a bug where the CELL LED wouldn't blink while the device was connecting to the network
41-
* Fixes a bug in the sandbox where some event flags could be cleared before being processed
31+
## Features
32+
* Add timeout parameter for HTTP(S)
4233

43-
# 1.2.0
34+
## Changes
35+
* LEDs toggle during HTTP queries (if the LED controller is not set to manual mode)
36+
* Correct the certificates extacted from `extract_certificates.ino` so that they have the correct authority key identifier
37+
* Cryptoauthlib is now in its own folder in `src` to make the source folder more structured
4438

45-
## Features
39+
## Bugfixes
40+
* Fix a bug where the device would not enter deep sleep due to the use of millis()
41+
* Fix a bug where the interrupt flag for the reset button was cleared after the device was reset in `sandbox.ino`
42+
* Fix a bug where pull-ups weren't enabled for some instances of SW0 and SW1 in the examples
4643

47-
* Split HTTP example into a HTTP and HTTPS example
48-
* Add a log message when HTTPS security profile is not set up
49-
* Update library.properties to pass lint checks for PR with library-registry
50-
* Improve error messages for MQTT
44+
## Deprecation notice
45+
* This release deprecates the use of `ECC608.getThingName(buffer, &size)` and `ECC608.getEndpoint(buffer, &size)`. Use `ECC608.readProvisionItem(type, buffer, &size)` instead. The `type` is an enum of `ecc_data_types` found in `ecc608.h`. To e.g. read the AWS thing name, use: `ECC608.readProvisionItem(AWS_THINGNAME, buffer, &size)`.
5146

52-
## Changes
47+
# 1.3.5
5348

54-
* Use Arduino interrupt system so that the library doesn't hijack interrupt service routines used by other libraries
55-
* Change sandbox application to use increased MQTT Quality of Service in order to not lose received messages
56-
* Remove MqttClient.disconnect() (full functionality given in MqttClient.end())
49+
## Changes
50+
* A CA is now mandatory for provisioning
51+
* The library now uses the latest version of cryptoauthlib
5752

5853
## Bugfixes
54+
* Fix a bug where the device would not go in deep sleep when using the low power modes
55+
* Fix a bug where a certificate would not be parsed correctly during provisioning
5956

60-
* Fix a bug where HTTP requests would make the modem hang
61-
* Add a temporary fix for a bug where the modem would not respond during MQTT publish and receive
62-
* Fix a bug where retrieving the modem clock would fail
57+
# 1.3.4
6358

64-
# 1.2.1
59+
## Features
60+
* Add a custom provisioning sketch for MQTT(S) and HTTP(S)
61+
* Reduce power consumption in low power from ~300uA to ~70uA
62+
* Add examples sketches for serial, GPIO and robust MQTT with connection loss
6563

6664
## Changes
67-
68-
* Update library name in library.properties file
65+
* Improved MQTT URC handling
66+
* Introduce an adjustable timout for Lte.begin()
6967

7068
## Bugfixes
69+
* Fix a bug where the reset pin was floating in the sandbox application
70+
* Fix a bug where reading the response in the SequansController would wrongly return an buffer overflow
7171

72-
* Fix dependency error in library.properties file
72+
# 1.3.3
7373

74-
# 1.2.2
74+
## Features
75+
* Add ability to add HTTP headers
76+
* Add ability for specifying content type for HTTP POST requests
7577

76-
No changes
78+
## Changes
79+
* Security profile patch is removed as this is now taken care of by NTP synchronization
80+
* Add Mqtt.end() in MQTT examples to prevent the broker waiting after running the example
7781

78-
# 1.2.3
82+
## Bugfixes
83+
* Fix a bug where Sequans.waitForURC would return true even when the URC was not received
7984

80-
## Features
85+
# 1.3.2
8186

82-
* Add GPS tracker example
87+
Internal build
8388

84-
## Changes
8589

86-
* Update MCP9808 library name in library.properties dependency field
87-
* Update VEML3328 library name in library.properties dependency field
88-
* Update Jenkins pipeline with new arduino-lint configurations
90+
91+
# 1.3.1
92+
93+
## Changes
94+
* Turn off more modules in low power to save more power
95+
* Add hardware-in-the-loop testing
8996

9097
## Bugfixes
98+
* Fix a bug where it would take some time before the board was actually in power down mode
99+
* Fix a bug where waking up from power down mode would reset the board
100+
* Fix a bug where it was wrongly reported that the SIM card was not ready
101+
91102

92-
* Fix a bug where the peripherals weren't powered up before the LTE module in power down mode
93-
* Fix a bug where the LEDs wouldn't blink after using power down mode
94103

95104
# 1.3.0
96105

@@ -113,84 +122,109 @@ No changes
113122
* Fix a bug where the NTP sync would retry if cellular network got disconnected while doing the sync
114123
* Fix a bug where the LEDs weren't returned to the previous state after a power save
115124

116-
# 1.3.1
117125

118-
## Changes
119-
* Turn off more modules in low power to save more power
120-
* Add hardware-in-the-loop testing
126+
# 1.2.3
121127

122-
## Bugfixes
123-
* Fix a bug where it would take some time before the board was actually in power down mode
124-
* Fix a bug where waking up from power down mode would reset the board
125-
* Fix a bug where it was wrongly reported that the SIM card was not ready
128+
## Features
129+
130+
* Add GPS tracker example
126131

132+
## Changes
127133

128-
# 1.3.2
134+
* Update MCP9808 library name in library.properties dependency field
135+
* Update VEML3328 library name in library.properties dependency field
136+
* Update Jenkins pipeline with new arduino-lint configurations
129137

130-
Internal build
138+
## Bugfixes
131139

140+
* Fix a bug where the peripherals weren't powered up before the LTE module in power down mode
141+
* Fix a bug where the LEDs wouldn't blink after using power down mode
132142

133-
# 1.3.3
134143

135-
## Features
136-
* Add ability to add HTTP headers
137-
* Add ability for specifying content type for HTTP POST requests
144+
# 1.2.2
145+
146+
No changes
147+
148+
# 1.2.1
138149

139150
## Changes
140-
* Security profile patch is removed as this is now taken care of by NTP synchronization
141-
* Add Mqtt.end() in MQTT examples to prevent the broker waiting after running the example
151+
152+
* Update library name in library.properties file
142153

143154
## Bugfixes
144-
* Fix a bug where Sequans.waitForURC would return true even when the URC was not received
145155

156+
* Fix dependency error in library.properties file
146157

147-
# 1.3.4
158+
159+
160+
# 1.2.0
148161

149162
## Features
150-
* Add a custom provisioning sketch for MQTT(S) and HTTP(S)
151-
* Reduce power consumption in low power from ~300uA to ~70uA
152-
* Add examples sketches for serial, GPIO and robust MQTT with connection loss
153163

154-
## Changes
155-
* Improved MQTT URC handling
156-
* Introduce an adjustable timout for Lte.begin()
164+
* Split HTTP example into a HTTP and HTTPS example
165+
* Add a log message when HTTPS security profile is not set up
166+
* Update library.properties to pass lint checks for PR with library-registry
167+
* Improve error messages for MQTT
168+
169+
## Changes
170+
171+
* Use Arduino interrupt system so that the library doesn't hijack interrupt service routines used by other libraries
172+
* Change sandbox application to use increased MQTT Quality of Service in order to not lose received messages
173+
* Remove MqttClient.disconnect() (full functionality given in MqttClient.end())
157174

158175
## Bugfixes
159-
* Fix a bug where the reset pin was floating in the sandbox application
160-
* Fix a bug where reading the response in the SequansController would wrongly return an buffer overflow
176+
177+
* Fix a bug where HTTP requests would make the modem hang
178+
* Add a temporary fix for a bug where the modem would not respond during MQTT publish and receive
179+
* Fix a bug where retrieving the modem clock would fail
161180

162181

163-
# 1.3.5
164182

165-
## Changes
166-
* A CA is now mandatory for provisioning
167-
* The library now uses the latest version of cryptoauthlib
183+
# 1.1.3
168184

169185
## Bugfixes
170-
* Fix a bug where the device would not go in deep sleep when using the low power modes
171-
* Fix a bug where a certificate would not be parsed correctly during provisioning
186+
187+
* Fixes a bug where the CELL LED wouldn't blink while the device was connecting to the network
188+
* Fixes a bug in the sandbox where some event flags could be cleared before being processed
172189

173190

174-
# 1.3.6
191+
192+
193+
# 1.1.2
175194

176195
## Features
177-
* Add timeout parameter for HTTP(S)
196+
* Add NTP synchronization in Lte.begin() if modem clock is not set
197+
198+
## Bugfixes
199+
* Fixes a bug for TLS certificate verification in certain regions
200+
* Fixes a bug where the power save functionality would not terminate
201+
* Reduce time used for querying for operator
178202

179-
## Changes
180-
* LEDs toggle during HTTP queries (if the LED controller is not set to manual mode)
181-
* Correct the certificates extacted from `extract_certificates.ino` so that they have the correct authority key identifier
182-
* Cryptoauthlib is now in its own folder in `src` to make the source folder more structured
203+
204+
205+
# 1.1.1
183206

184207
## Bugfixes
185-
* Fix a bug where the device would not enter deep sleep due to the use of millis()
186-
* Fix a bug where the interrupt flag for the reset button was cleared after the device was reset in `sandbox.ino`
187-
* Fix a bug where pull-ups weren't enabled for some instances of SW0 and SW1 in the examples
188208

189-
## Deprecation notice
190-
* This release deprecates the use of `ECC608.getThingName(buffer, &size)` and `ECC608.getEndpoint(buffer, &size)`. Use `ECC608.readProvisionItem(type, buffer, &size)` instead. The `type` is an enum of `ecc_data_types` found in `ecc608.h`. To e.g. read the AWS thing name, use: `ECC608.readProvisionItem(AWS_THINGNAME, buffer, &size)`.
209+
* Fixes a bug where LTE connectivity in sandbox was not reconnecting
210+
* Added temporarily work around for TLS certificate verification in certain regions
191211

212+
# 1.1.0
192213

193-
# 1.3.7
214+
## Features
215+
216+
* Added sensor driver shutdown to lower power examples
217+
* Refactored sandbox to use modulo instead of masking
218+
* Added a simple CLI for the sandbox
194219

195220
## Bugfixes
196-
* Fix a bug where a disconnect from the network whilst being connected to a MQTT broker would cause the board to not respond
221+
222+
* Fixed a bug where the board buttons were disabled during sleep, and could not wake up the MCU
223+
* Removed configuring button as input again after not disabling it
224+
* Fixed a bug where flow control was not correctly applied when the receive buffer was full. This particularly affected the sandbox.
225+
226+
227+
# 1.0.0
228+
229+
* Initial Release
230+

0 commit comments

Comments
 (0)