iOS Smokerlyzer SDK Changelog

2.0.3 Release 17 February, 2025

Fixed
Firmware versions that previously lacked zeroing functionality and experienced connectivity issues have been resolved in this release.
Changed
The minimum OS version has been updated from 11 to 14 and the maximum is now set to 18 (the latest available version).

2.0.2 Release March 26, 2024

Fixed
Resolved previous test result showing on new tests.
Changed
SDK version incremented for release from 2.0.2.beta1 to 2.0.2

2.0.2.beta1 Beta February 2, 2024

Fixed
Resolved previous test result showing on new tests.
Changed
SDK version incremented for Beta testing from 2.0.1 to 2.0.2.beta1

2.0.1 Release February 3, 2023

Changed
Changed version from 2.0.0.dev6 to 2.0.1 as Apple require three period-separated integers for version numbering.

2.0.0.dev6 Beta August 4, 2022

Changed
Ambient test detection is now stricter (matches production app implementation).
Fixed
Breath test results cleared off after every test.
Fixed
Recovery not working after a high ppm reading is fixed.
Fixed
UNTESTED fix for breath test being stuck on stopped state.
Additional Developer Notes
Please note this SDK version is a beta release and has undergone only basic testing during development. This version can only be used for DEMONSTRATION PURPOSES only.

2.0.0.dev5 Beta June 8, 2022

Added
XCode 13/iOS 15 support from base Bluejay library.
Changed
Breath test result now uses the max of all readings instead of the last stable reading. If the breath test only picks up ambient CO readings, it will return 0 even if the max is non-zero.
Changed
Timings: initialization phase is now 14 seconds, and reading/stability phase is 6-16 seconds depending on stability (for a max of 30s).
Changed
Stability now determines if breath test should finish early rather than as a pass/fail. Stability tolerance changed to +-1 PPM of the baseline, and 6 stable readings are required for the breath test to finish early.
Deprecated
BluejayError.failedToStabilize will no longer be emitted.
Additional Developer Notes
Please note this SDK version is a beta release and has undergone only basic testing during development. This version can only be used for DEMONSTRATION PURPOSES only.

2.0.0.dev4 Beta January 21, 2022

Added
Update README and documentation (functionality not impacted).
Additional Developer Notes
Please note this SDK version is a beta release and has undergone only basic testing during development. This version can only be used for DEMONSTRATION PURPOSES only.

2.0.0.dev3 Beta December 09, 2021

Changed
disconnect() also stops any ongoing scans.
Fixed
Initialization period check no longer cuts initialization 1 second short.
Fixed
LogForwarder now reports messages from SmokerlyzerSDK, not just underlying Bluejay library.
Fixed
Avoid multiple disconnect events on connection loss.
Additional Developer Notes
Please note this SDK version is a beta release and has undergone only basic testing during development. This version can only be used for DEMONSTRATION PURPOSES only.

2.0.0.dev2 Beta December 07, 2021

Added
New error codes .zeroingRequired and .deviceNotReady for when the SDK detects that the sensor needs to zero or is currently zeroing, respectively. All functions that interact with the CO sensor may return these error codes.
Added
ConnectionUpdate protocol which returns more detailed connection state information beyond success or failure.
Added
New scanAndConnect() function which, going forward, will be the only way to connect to a Smokerlyzer device since it handles zeroing and has been updated to use ConnectionUpdate protocol.
Added
New error codes .scanFailed and .failedToFinalize for scanAndConnect() function, and .failedToStabilize for breath test functions.
Added
getDeviceName(), getIsConnected() functions for parity with Android SDK.
Added
New enableSensor() and disableSensor() which are zeroing-aware versions of setSensorState().
Added
New error codes .zeroingRequired and .deviceNotReady for when the SDK detects that the sensor needs to zero or is currently zeroing, respectively. All functions that interact with the CO sensor may return these error codes.
Changed
getBatteryLife() renamed to getBatteryReading()
Changed
getSerial() renamed to getSerialNumber()
Changed
getUsageCount() renamed to getUsage()
Changed
disconnectFromPeriperhal() renamed to disconnect()
Fixed
Firmware version now parses correctly.
Depreciated
getCoppm() from SmokerlyzerBluetooth
Depreciated
scanForPeripheral() from SmokerlyzerBluetooth
Depreciated
connectToPeripheral() from SmokerlyzerBluetooth
Depreciated
setSensorState() from SmokerlyzerBluetooth
Additional Developer Notes
Please note this SDK version is a beta release and has undergone only basic testing during development. This version can only be used for DEMONSTRATION PURPOSES only.

2.0.0.dev1 Beta October 27, 2021

Added
Split the breath test and recovery phases from startBreathTest() function into two separate functions handleRecovery() and startBreathTestNoRecovery(). Original function is preserved.
Added
RecoveryResult enum which reports the result of a recovery attempt back to the user.
Changed
Device recovery notifications now use custom RecoveryObserver protocol instead of RecoveryTracker.
Changed
.failedToRecover error description has more detail.
Changed
Removed RxSwift and RxCocoa dependencies.
Additional Developer Notes
Please note this SDK version is a beta release and has undergone only basic testing during development. This version can only be used for DEMONSTRATION PURPOSES only.

2.0.0 Release August 09, 2021

Added
Addition of recovery phase as part of the breath test function. The library enters into a recovery mode if the devices sensor is reading greater than 5PPM.
Added
Addition of recovery tracker to track recovery state changes as part of the recovery implementation.
Added
Addition of new breath test variables. The library shall now initialise for a period of 8 seconds up from 5 seconds. The library shall now only have a tolerance of +/- 2PPM down from +/- 3 PPM.
Additional Developer Notes
We are currently aware of the decimal place missing from temperature, this will be actioned on a future release, for the interim divide by 10.

1.1.0 Release April 09, 2021

Added
New breath test method which shall reset the baseline reading stability reading while the test duration is less than 5 seconds. 7 Stablised readings are required for successful breath test, else 999 is returned to signal failed test. Total minimum breath test duratin shall be 11 seconds.
Added
Addition of device usage count functionality.
Additional Developer Notes
We are currently aware of the decimal place missing from temperature, this will be actioned on a future release, for the interim divide by 10.

1.0.6 Beta November 11, 2020

Changed
Updated condition within the _startBreathTest function to expand the scope of a breath test that has failed to stabilize
Additional Developer Notes
Please note this SDK version is a beta release and has undergone only basic testing during development. This version can only be used for DEMONSTRATION PURPOSES only.

1.0.5 Beta November 10, 2020

Added
Added new class variables to SmokerlyzerBluetooth class to support refactored breath test function.
Added
resetToDefaults() function to reset class variables back to the default states after a breath test.
Changed
Inner _startBreathTest function to be inline with other products. The test now waits until it has 7 stable readings.
Changed
public startBreathTest function to only accept a callback as a parameter
Depreciated
Max() function from PPMResult
Depreciated
Average() function from PPMResult
Additional Developer Notes
Please note this SDK version is a beta release and has undergone only basic testing during development. This version can only be used for DEMONSTRATION PURPOSES only.

1.0.4 Beta September 14, 2020

Added
Generate and save updated documentation to /docs
Changed
Update documentation configuration file (“jazzy.yaml”)
Changed
Update README.

1.0.3 Beta September 10, 2020

Added
Add comments to all user-visible parts of the API
Fixed
Fix API visability issues:
User is prevented from viewing or accessing Bluejay classes by setting them all package-private, except for BluejayError.
Characteristic (de)serialization functions set to package-private.
Characteristic identifier set to public.

1.0.2 Beta Septemebr 01, 2020

Added
Added XCFramework support
Changed
Removed XCGLogger dependency
Changed
Build target lowered to iOS 10.2

1.0.1 Beta August 11, 2020

Changed
Split scan and connect functions
Changed
Updated demo app.
Fixed
Fixed breath test functionality
Depreciated
Removed pressure characteristic

1.0.0 Beta August 08, 2020

Added
Inital set of supported characteristics: Battery, CoEnable, Firmware, PPM, Pressure, Serial and Temperature.
Added
Smokerlyzer Demo App with the ability to; scan and connect, observe, logging, BLE Write, BLE Read, BLE Notify, Breath Test.