Android Smokerlyzer SDK Changelog

2.0.0.17 Release February 26, 2025

Fixed

Firmware versions that previously lacked zeroing functionality and experienced connectivity issues have been resolved in this release.

Changed

Security has been enhanced at the consumer level and ProGuard rules have been implemented.

2.0.0.16 Release March 26, 2024

Fixed

Resolved previous test result showing on new tests.

Fixed

Resolved Ambient results being displayed twice.

Fixed

Resolved App not connecting on first attempt.

Changed

SDK version incremented for Beta testing from 2.0.0.16.beta1 to 2.0.0.16

2.0.0.16.beta1 Beta March 2, 2024

Fixed

Resolved previous test result showing on new tests.

Fixed

Resolved Ambient results being displayed twice.

Fixed

Resolved App not connecting on first attempt.

Changed

SDK version incremented for Beta testing from 2.0.0.15 to 2.0.0.16.beta1

2.0.0.15 Beta August 4, 2022

Changed

Apply permissions update from RxJava 1.13.1

Changed

Ambient test detection is now stricter (matches production app implementation).

2.0.0.14 Beta June 8, 2022

Added

New Android 12 BLE permissions declared in library manifest per this article. See the demo app source for an example of how to request/manage the permissions.

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.

Changed

Breath test timer implementation improved; BLE operations no longer cause a delay on the timer. Timer period changed to 100ms, ensuring that each BLE read (which still happens every second) cannot deviate more than 100ms from when the read is supposed to happen.

Deprecated

StatusCodeConstants.SUCCESS_FAILED_TO_STABILISE will no longer be emitted.

Additional Developer Notes

Fixed wrong 'Added'/'Changed' badge colors being used in some changelog entries.

2.0.0.13 Beta October 22, 2021

Added

Allow user to directly manipulate CO sensor via enableSensor() and disableSensor().

Added

New error codes ERROR_ZEROING_REQUIRED and ERROR_DEVICE_NOT_READY 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; see documentation.

Changed

On initial connection: always enable the sensor, and if necessary, allow the sensor to zero out.

Changed

Added callbacks to scanAndConnect() that may return new status codes SUCCESS, ZEROING (interim state), SUCCESS_NEEDS_RECOVERY, ERROR_SCAN_FAILED, ERROR_FAILED_TO_CONNECT, and ERROR_FAILED_TO_FINALIZE. See documentation for full description.

Changed

Connection tracker fixed; was not returning 'false' when the connection object was disposed.

Changed

Don't disconnect at the end of a breath test if the breath test status was SUCCESS or SUCCESS_FAILED_TO_STABILIZE.

Changed

Removed duration argument from breath test; breath test should always run for a max of 30 seconds (but may run for shorter depending on stability phase; see timing diagram).

Additional Developer Notes

2.0.0.13 is the bugfixed version of 2.0.0.11 and 2.0.0.12.

2.0.0.10 Beta October 22, 2021

Added

Split the breath test and recovery phases from startBreathTest() function into two separate functions handleRecovery() and startBreathTestNoRecovery(). Original function is preserved.

Changed

Error handling and logging on every single BLE interaction such that it should not be possible for the SDK to "hang" while running a breath test.

Changed

Prevent recovery from exiting early under certain conditions by properly resetting the variable that tracks the elapsed time.

Additional Developer Notes

2.0.0.10 is the bugfixed version of 2.0.0.9

Logging was shifted around to reduce code redundancy; log statements may occur at slightly different times than before.

2.0.0.0 Release August 09, 2021

Added

New v2 package to support new bluetooth communication functionality in order to make communicating more streamline without the use of intents. Developers can now use callbacks in order to get response from the SmokerlyzerBluetoothLeManager instance.

Added

Addition of breath test recovery phase if the device sensor is still reading greater than 5 PPM.

Added

Addition of new variables for breath test. Breath test now has 8 seconds initalisation, in addition the breath test tolerance is now +/- 2 PPM from +/- 3 PPM.

Added

Addition of trackers to track the state of Recovery, Connection, Scanning and Connecting, these trackers can be subscribed to in fragments and activties.

Additional Developer Notes

v1 package is now depreciated, however shall remain in the codebase to allow transition to v2.

1.1.0.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.

Added

Addition of obtaining device serial number 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.3.3 Beta October 22, 2020

Changed

DIRECT_CONNECTION_DELAY_IN_MS from 100ms to 0ms.

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 DEMONSTATION PURPOSES only.

1.0.3.2 Beta October 22, 2020

Changed

DIRECT_CONNECTION_DELAY_IN_MS from 100ms to 500ms.

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 DEMONSTATION PURPOSES only.

1.0.3.1 Beta October 22, 2020

Changed

DIRECT_CONNECTION_DELAY_IN_MS from 100ms to 50ms.

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 DEMONSTATION PURPOSES only.

1.0.3.0 Beta October 22, 2020

Changed

MAX_CONNECTION_RETRIES from 1 attempt to 3 attempts.

Changed

DIRECT_CONNECTION_DELAY_IN_MS from 100ms to 250ms.

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 DEMONSTATION PURPOSES only.

1.0.2.0 Beta October 21, 2020

Changed

TIMEOUT_THRESHOLD_SAMSUNG from 5000ms to 10000ms.

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 DEMONSTATION PURPOSES only.

1.0.1.6 Beta October 16, 2020

Added

Added SecondsTimer Class to assist with breath test functionality.

Added

Added a the new private method StartBreathTest(int, ReadingComplete) which is a replacement for the depreciated startBreathTest(int sampleDurationMs) method.

Added

Added a the new public method StartBreathTest(int, ReadingComplete) which is a replacement for the depreciated startBreathTest(int sampleDurationMs) method, the result of this function can be accessed through a callback.

Added

Added a the new private method ReadPPMLoop(int sampleReadDuration, SmokerlyzerBluetoothLeManager.ReadingComplete cb) which improves the reading stability through a new algorithm.

Changed

Build.Gradle now updated with new version code.

Deprecated

startBreathTest(int sampleDurationMs) is now depreciated.

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 DEMONSTATION PURPOSES only.

1.0.0.8 Release August 26, 2020

Added

Additional error codes within the BluetoothCentral class to help improve error logging.

Added

BluetoothBytesParser Class to assist with the conversion to bytes and vice versa.

Changed

Updated the build.gradle file and the repository URL to support a development and production environment.

Changed

Updated the build.gradle file to include one generic access key for all SDK consumers.

Changed

Adjusted the scan restart delay to 1000ms

Changed

scanForPeripheral() now requires additional parameters of an array of strings for device names and a long for scan duration. The requirements for this method can be found within the JavaDoc.

Changed

startBreathTest() now requires a scan duration parameter. The requirements for this parameter can be found within the JavaDoc.

Deprecated

ISmokerlyzerBluetoothCommander is now depreciated. The interface class is no longer required as all the implementation logic can now be done within the SmokerlyzerBluetoothInterpreter and SmokerlyzerBluetoothLeManager.

Deprecated

Calibration Methods are now depreciated.

0.0.0.2 Beta April 2, 2020

Added

Initial beta release of the Android Smokerlyzer SDK.

0.0.0.1 Beta April 1, 2020

Added

Initial internal release of the Android Smokerlyzer SDK.