Microfire LLC Mod-ORP Raspberry Pi Library
Copyright © 2023 Microfire LLC
This documentation is licensed under a Creative Commons Attribution-NoDerivatives 4.0 International (CC BY-ND).
Release | Date | Description |
2.0.0 | 3/29/2023 | Changes for version 2 hardware |
1.0.0 | 5/10/2021 | Initial |
TECHNICAL AND RELIABILITY DATA FOR MICROFIRE LLC PRODUCTS (INCLUDING DATASHEETS) AS MODIFIED FROM TIME TO TIME (“RESOURCES”) ARE PROVIDED BY MICROFIRE LLC "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW IN NO EVENT SHALL MICROFIRE LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THE RESOURCES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
MICROFIRE LLC reserves the right to make any enhancements, improvements, corrections or any other modifications to the RESOURCES or any products described in them at any time and without further notice.
The RESOURCES are intended for skilled users with suitable levels of design knowledge. Users are solely responsible for their selection and use of the RESOURCES and any application of the products described in them. User agrees to indemnify and hold MICROFIRE LLC harmless against all liabilities, costs, damages or other losses arising out of their use of the RESOURCES.
HIGH RISK ACTIVITIES. MICROFIRE LLC products are not designed, manufactured or intended for use in hazardous environments requiring fail safe performance, such as in the operation of nuclear facilities, aircraft navigation or communication systems, air traffic control, weapons systems or safety-critical applications (including life support systems and other medical devices), in which the failure of the products could lead directly to death, personal injury or severe physical or environmental damage, or business loss (“High Risk Activities”). MICROFIRE LLC specifically disclaims any express or implied warranty of fitness for High Risk Activities and accepts no liability for use or inclusions of MICROFIRE LLC products in High Risk Activities.
Microfire LLC Mod-ORP Raspberry Pi Library
This Python library can installed through pip in a terminal:
pip3 install Microfire-Mod-ORP |
Typing python3 -m Microfire_Mod_ORP.shell will start the shell application and give access to all features and functions of the module. Type help to see a listing of the commands available.
mV value from the probe.
Single offset calibration data. If there is no calibration data present, NaN (not a number) is returned.
Hardware version of the module.
Firmware version of the module.
Status code of the last measurement or calibration.
0: STATUS_NO_ERROR
1: STATUS_SYSTEM_ERROR
Initializes the library and determines if the module is connected.
def begin(i2c_bus=1, address=0x0E) |
Parameter | Description |
i2c_bus | TwoWire I2C interface |
address | I2C address of the module |
Type | Description |
bool | True if the module is connected. False if the module is disconnected. |
import Microfire_Mod_ORP |
Determines if the module is connected.
def connected() |
Parameter | Description |
None |
Type | Description |
bool | True if the module is connected. False if the module is disconnected. |
import Microfire_Mod_ORP |
Performs a single-point calibration. status and calibrationSingleOffset are updated. It takes 750 ms to complete a measurement.
def calibrateSingle(solution_mV, blocking=True) |
Parameter | Description |
solution_mV | The mV of the calibration solution. |
blocking | Return immediately or wait for the module to complete the calibration |
Type | Description |
int | An error code for the measurement. Can be one of the following: 0: no error 1: system error |
import Microfire_Mod_ORP |
Updates all measurement, calibration, and system registers with the most recent information.
def getDeviceInfo() |
Parameter | Description |
None |
Type | Description |
None |
import Microfire_Mod_ORP |
Starts an ORP measurement.
Member variables mV and status are updated.
def measureORP(blocking=True) |
Parameter | Description |
blocking | Return immediately or wait for the module to complete the measurement |
Type | Description |
float | The solution-under-test’s ORP value. |
import Microfire_Mod_ORP |
Resets all calibration data to the empty value of NaN (not a number).
def reset() |
Parameter | Description |
None |
Type | Description |
None |
import Microfire_Mod_ORP |
Sets all the device calibration registers with a specified value.
def setDeviceInfo(calibrationSingleOffset) |
Parameter | Description |
calibrationSingleOffset | Single-offset calibration data |
Type | Description |
None |
import Microfire_Mod_ORP |
Changes the I2C address of the module. The change is stored and used again after a power cycle.
Note: The library will use the new I2C address after calling this method, but the address must be stored and begin must be appropriately called with the new address on subsequent initialization.
def setI2CAddress(i2cAddress) |
Parameter | Description |
int | New I2C address |
Type | Description |
None |
import Microfire_Mod_ORP |
If blocking is set to false when measureORP is called, this method will update mV. This allows the controlling device to do other work rather than wait for the module to complete the measurement.
def update() |
Parameter | Description |
None |
Type | Description |
None |
import Microfire_Mod_ORP |