qwiic_ultrasonic.QwiicUltrasonic Class Reference

Inheritance diagram for qwiic_ultrasonic.QwiicUltrasonic:

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	trigger_and_read (self)
	Triggers a new measurement and reads the previous one. More...
def	change_address (self, address)
	Changes the I2C address of the Qwiic Ultrasonic sensor. More...
def	get_address (self)
	Gets the current I2C address of the Qwiic Ultrasonic sensor. More...

Public Attributes
	address

Static Public Attributes
	device_name = _DEFAULT_NAME
	available_addresses = _AVAILABLE_I2C_ADDRESS
int	kMinAddress = 0x20
int	kMaxAddress = 0x2F
int	kDefaultAddress = 0x2F
int	kRegisterTrigger = 0x01

Properties
	connected = property(is_connected)

Constructor & Destructor Documentation

__init__()

def qwiic_ultrasonic.QwiicUltrasonic.__init__	(		self,
			address = None,
			i2c_driver = None
	)

Constructor.

Parameters

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

Member Function Documentation

begin()

def qwiic_ultrasonic.QwiicUltrasonic.begin

(

self

)

Initializes this device with default parameters.

Returns

bool Returns True if successful, otherwise False

change_address()

def qwiic_ultrasonic.QwiicUltrasonic.change_address	(		self,
			address
	)

Changes the I2C address of the Qwiic Ultrasonic sensor.

Parameters

int	address: New address, must be in the range 0x20 to 0x2F

Returns

bool Returns True if successful, otherwise False

get_address()

def qwiic_ultrasonic.QwiicUltrasonic.get_address

(

self

)

Gets the current I2C address of the Qwiic Ultrasonic sensor.

Returns

int The current I2C address, 7-bit unshifted

is_connected()

def qwiic_ultrasonic.QwiicUltrasonic.is_connected

(

self

)

Determines if this device is connected.

Returns

bool True if connected, otherwise False

trigger_and_read()

def qwiic_ultrasonic.QwiicUltrasonic.trigger_and_read

(

self

)

Triggers a new measurement and reads the previous one.

Returns

int Distance in mm

Member Data Documentation

address

qwiic_ultrasonic.QwiicUltrasonic.address

available_addresses

qwiic_ultrasonic.QwiicUltrasonic.available_addresses = _AVAILABLE_I2C_ADDRESS

static

device_name

qwiic_ultrasonic.QwiicUltrasonic.device_name = _DEFAULT_NAME

static

kDefaultAddress

int qwiic_ultrasonic.QwiicUltrasonic.kDefaultAddress = 0x2F

static

kMaxAddress

int qwiic_ultrasonic.QwiicUltrasonic.kMaxAddress = 0x2F

static

kMinAddress

int qwiic_ultrasonic.QwiicUltrasonic.kMinAddress = 0x20

static

kRegisterTrigger

int qwiic_ultrasonic.QwiicUltrasonic.kRegisterTrigger = 0x01

static

Property Documentation

connected

qwiic_ultrasonic.QwiicUltrasonic.connected = property(is_connected)

static

---

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

• qwiic_ultrasonic.py