Microfire LLC SHT3x Raspberry Pi Library

Microfire LLC SHT3x Raspberry Pi Library

Release Information

Copyright © 2021 Microfire LLC

This documentation is licensed under a Creative Commons Attribution-NoDerivatives 4.0 International (CC BY-ND).

Release History

Release

Date

Description

1.0.0

7/25/2021

Initial

Legal Disclaimer

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 SHT3x Raspberry Pi Library

Release Information

Release History

Legal Disclaimer

Library Documentation

Installation

Member Variables

const float tempC

const float tempF

const float vpd_kPa

const float dew_pointC

const float dew_pointF

const int RH

const int status

Member Methods

begin

Definition

Parameters

Return

Example

connected

Definition

Parameters

Return

Example

measure

Definition

Parameters

Return

Example


Library Documentation

Installation

This Python library can be installed through pip in a terminal:

pip3 install Microfire_SHT3x 

Typing python3 -m Microfire_SHT3x.shell will start the shell application and give access to the sensor. Type help to see a listing of the commands available.

Member Variables

const float tempC

Temperature measurement, in Celsius.

const float tempF

Temperature measurement, in Fahrenheit.

const float vpd_kPa

Vapor pressure deficit in kilopascals.

const float dew_pointC

The dew point, in Celsius

const float dew_pointF

The dew point, in Fahrenheit

const int RH

Relative humidity.

const int status

Status code of the last measurement or calibration.

0: STATUS_NO_ERROR

1: STATUS_NOT_CONNECTED

2: STATUS_CRC_ERROR

Member Methods

begin

Initializes the library and determines if the module is connected.

Definition

def begin(i2c_bus=1)

Parameters

Parameter

Description

i2c_bus

TwoWire I2C interface

Return

Type

Description

bool

True if the module is connected.

False if the module is disconnected.

Example

from Microfire_SHT3x import Microfire_SHT3x
sht30 = Microfire_SHT3x()

if not sht30.begin():
   print(
"Error")


connected

Determines if the sensor is connected.

Definition

def connected()

Parameters

Parameter

Description

None

Return

Type

Description

bool

True if the module is connected.

False if the module is disconnected.

Example

from Microfire_SHT3x import Microfire_SHT3x
sht30 = Microfire_SHT3x()

sht30.begin()
if not sht30.connected():
   print(
"Error")


measure

Starts a measurement. A measurement takes 20 ms to complete.

Member variables tempC, tempF, vpd_kPa, RH, dew_pointC, dew_pointF, and status are updated.

Definition

def measure()

Parameters

Parameter

Description

None

Return

Type

Description

int

An error code for the measurement. Can be one of the following:

0: no error

1: no sensor connected

2: CRC error

Example

from Microfire_SHT3x import Microfire_SHT3x
sht30 = Microfire_SHT3x()

sht30.begin()
sht30.measure()

if sht30.status:
   print(
"Error: " + sht30.status_string[sht30.status])
else:
   print(str(
"{:.3f}".format(sht30.tempC)) + "°C")
   print(str(
"{:.3f}".format(sht30.tempF)) + "°F")
   print(str(
"{:.3f}".format(sht30.vpd_kPa)) + " VPD kPa")
   print(str(
"{:.3f}".format(sht30.dew_pointC)) + " dew point °C")
   print(str(
"{:.3f}".format(sht30.dew_pointF)) + " dew point °F")
   print(str(
"{:.3f}".format(sht30.RH)) + " %RH")