Qwiic_FS3000_Py  2.0.0-2-g63abba7
Python for SFE Qwiic FS3000
Loading...
Searching...
No Matches
qwiic_fs3000.QwiicFS3000 Class Reference
Inheritance diagram for qwiic_fs3000.QwiicFS3000:

Public Member Functions

def __init__ (self, address=None, i2c_driver=None)
 Constructor. More...
 
def is_connected (self)
 Determines if this device is connected. More...
 
def begin (self)
 Initializes this device with default parameters. More...
 
def set_range (self, range)
 There are two varieties of this sensor (1) FS3000-1005 (0-7.23 m/sec) and (2) FS3000-1015 (0-15 m/sec) More...
 
def checksum (self, data_in)
 CHECKSUM Check to see that the CheckSum is correct, and data is good Return true if all is good, return false if something is off
The entire response from the FS3000 is 5 bytes. More...
 
def read_raw (self)
 Read from sensor, checksum, return raw data (409-3686) More...
 
def read_meters_per_second (self)
 Read from sensor, checksum, return m/s (0-7.23) More...
 
def read_miles_per_hour (self)
 Read from sensor, checksum, return mph (0-33ish) More...
 

Public Attributes

 address
 

Static Public Attributes

 device_name = _DEFAULT_NAME
 
 available_addresses = _AVAILABLE_I2C_ADDRESS
 
int kAirflowRange7Mps = 0
 
int kAirflowRange15Mps = 1
 

Properties

 connected = property(is_connected)
 

Constructor & Destructor Documentation

◆ __init__()

def qwiic_fs3000.QwiicFS3000.__init__ (   self,
  address = None,
  i2c_driver = None 
)

Constructor.

Parameters
int,optionaladdress: The I2C address to use for the device If not provided, the default address is used
I2CDriver,optionali2c_driver: An existing i2c driver object If not provided, a driver object is created

Member Function Documentation

◆ begin()

def qwiic_fs3000.QwiicFS3000.begin (   self)

Initializes this device with default parameters.

Returns
bool Returns True if successful, otherwise False

◆ checksum()

def qwiic_fs3000.QwiicFS3000.checksum (   self,
  data_in 
)

CHECKSUM Check to see that the CheckSum is correct, and data is good Return true if all is good, return false if something is off
The entire response from the FS3000 is 5 bytes.

[0]Checksum [1]data high [2]data low [3]generic checksum data [4]generic checksum data

Parameters
listdata_in: The data to check
Returns
bool Returns True if successful, otherwise False

◆ is_connected()

def qwiic_fs3000.QwiicFS3000.is_connected (   self)

Determines if this device is connected.

Returns
bool True if connected, otherwise False

◆ read_meters_per_second()

def qwiic_fs3000.QwiicFS3000.read_meters_per_second (   self)

Read from sensor, checksum, return m/s (0-7.23)

Returns
float The air velocity value in meters per second (or -1 on error)

◆ read_miles_per_hour()

def qwiic_fs3000.QwiicFS3000.read_miles_per_hour (   self)

Read from sensor, checksum, return mph (0-33ish)

Returns
float The air velocity value in miles per hour (or -1 on error)

◆ read_raw()

def qwiic_fs3000.QwiicFS3000.read_raw (   self)

Read from sensor, checksum, return raw data (409-3686)

Returns
int The raw value from the sensor (or -1 on error)

◆ set_range()

def qwiic_fs3000.QwiicFS3000.set_range (   self,
  range 
)

There are two varieties of this sensor (1) FS3000-1005 (0-7.23 m/sec) and (2) FS3000-1015 (0-15 m/sec)

Valid input arguments are: AIRFLOW_RANGE_7_MPS AIRPLOW_RANGE_15_MPS

Note, this also sets the datapoints (from the graphs in the datasheet pages 6 and 7). These datapoints are used to convert from raw values to m/sec - and then mph.

Parameters
intrange: The range of the sensor
Returns
bool Returns True if successful, otherwise False

Member Data Documentation

◆ address

qwiic_fs3000.QwiicFS3000.address

◆ available_addresses

qwiic_fs3000.QwiicFS3000.available_addresses = _AVAILABLE_I2C_ADDRESS
static

◆ device_name

qwiic_fs3000.QwiicFS3000.device_name = _DEFAULT_NAME
static

◆ kAirflowRange15Mps

int qwiic_fs3000.QwiicFS3000.kAirflowRange15Mps = 1
static

◆ kAirflowRange7Mps

int qwiic_fs3000.QwiicFS3000.kAirflowRange7Mps = 0
static

Property Documentation

◆ connected

qwiic_fs3000.QwiicFS3000.connected = property(is_connected)
static

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