Qwiic_MicroPressure_Py  2.0.0-3-gb362b6e
Python for SFE Qwiic Micropressure
Loading...
Searching...
No Matches
qwiic_micropressure.QwiicMicroPressure Class Reference
Inheritance diagram for qwiic_micropressure.QwiicMicroPressure:

Public Member Functions

def __init__ (self, address=None, i2c_driver=None)
 Constructor. More...
 
def is_connected (self)
 Determines if the device is connected. More...
 
def begin (self)
 Initializes the device with default parameters. More...
 
def read_pressure (self, units=kPressurePsi)
 Reads the pressure from the sensor. More...
 

Public Attributes

 address
 

Static Public Attributes

 device_name = _DEFAULT_NAME
 
 available_addresses = _AVAILABLE_I2C_ADDRESS
 
int kReadPressureCommandReg = 0xAA
 
int kReadPressureCommandData = 0x0000
 
int kMathSatMask = 1 << 0
 
int kMemoryIntegrityMask = 1 << 1
 
int kBusyMask = 1 << 5
 
int kPowerIndicationMask = 1 << 6
 
int kOutputMin = 0x19999A
 
int kOutputMax = 0xE66666
 
int kMaxPSI = 25
 
int kMinPSI = 0
 
int kPressurePsi = 0
 
int kPressurePa = 1
 
int kPressureKpa = 2
 
int kPressureTorr = 3
 
int kPressureInHg = 4
 
int kPressureAtm = 5
 
int kPressureBar = 6
 

Properties

 connected = property(is_connected)
 

Constructor & Destructor Documentation

◆ __init__()

def qwiic_micropressure.QwiicMicroPressure.__init__ (   self,
  address = None,
  i2c_driver = None 
)

Constructor.

Parameters
intaddress: The I2C address to use for the device. If not provided, the default address is used
I2CDriveri2c_driver: An existing i2c driver object. If not provided, a driver object is created

Member Function Documentation

◆ begin()

def qwiic_micropressure.QwiicMicroPressure.begin (   self)

Initializes the device with default parameters.

Returns
bool Trueif the device was successfully initialized, otherwiseFalse``

◆ is_connected()

def qwiic_micropressure.QwiicMicroPressure.is_connected (   self)

Determines if the device is connected.

Returns
bool True if the device is connected, otherwise False

◆ read_pressure()

def qwiic_micropressure.QwiicMicroPressure.read_pressure (   self,
  units = kPressurePsi 
)

Reads the pressure from the sensor.

Parameters
intunits: The units to return the pressure in. Use one of the kPressure* constants
Returns
: The pressure in Pascals, or -1 on error

Member Data Documentation

◆ address

qwiic_micropressure.QwiicMicroPressure.address

◆ available_addresses

qwiic_micropressure.QwiicMicroPressure.available_addresses = _AVAILABLE_I2C_ADDRESS
static

◆ device_name

qwiic_micropressure.QwiicMicroPressure.device_name = _DEFAULT_NAME
static

◆ kBusyMask

int qwiic_micropressure.QwiicMicroPressure.kBusyMask = 1 << 5
static

◆ kMathSatMask

int qwiic_micropressure.QwiicMicroPressure.kMathSatMask = 1 << 0
static

◆ kMaxPSI

int qwiic_micropressure.QwiicMicroPressure.kMaxPSI = 25
static

◆ kMemoryIntegrityMask

int qwiic_micropressure.QwiicMicroPressure.kMemoryIntegrityMask = 1 << 1
static

◆ kMinPSI

int qwiic_micropressure.QwiicMicroPressure.kMinPSI = 0
static

◆ kOutputMax

int qwiic_micropressure.QwiicMicroPressure.kOutputMax = 0xE66666
static

◆ kOutputMin

int qwiic_micropressure.QwiicMicroPressure.kOutputMin = 0x19999A
static

◆ kPowerIndicationMask

int qwiic_micropressure.QwiicMicroPressure.kPowerIndicationMask = 1 << 6
static

◆ kPressureAtm

int qwiic_micropressure.QwiicMicroPressure.kPressureAtm = 5
static

◆ kPressureBar

int qwiic_micropressure.QwiicMicroPressure.kPressureBar = 6
static

◆ kPressureInHg

int qwiic_micropressure.QwiicMicroPressure.kPressureInHg = 4
static

◆ kPressureKpa

int qwiic_micropressure.QwiicMicroPressure.kPressureKpa = 2
static

◆ kPressurePa

int qwiic_micropressure.QwiicMicroPressure.kPressurePa = 1
static

◆ kPressurePsi

int qwiic_micropressure.QwiicMicroPressure.kPressurePsi = 0
static

◆ kPressureTorr

int qwiic_micropressure.QwiicMicroPressure.kPressureTorr = 3
static

◆ kReadPressureCommandData

int qwiic_micropressure.QwiicMicroPressure.kReadPressureCommandData = 0x0000
static

◆ kReadPressureCommandReg

int qwiic_micropressure.QwiicMicroPressure.kReadPressureCommandReg = 0xAA
static

Property Documentation

◆ connected

qwiic_micropressure.QwiicMicroPressure.connected = property(is_connected)
static

The documentation for this class was generated from the following file: