Spike Prime & Robot Inventor python Library Reference
Spike Prime & Robot Inventor python Library
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lib.mindsensors.DIST Class Reference
Inheritance diagram for lib.mindsensors.DIST:
lib.mindsensors.SPIKEi2c

Public Member Functions

def __init__ (self, port, dist_address=DIST_ADDRESS)
 Initialize the class with the i2c address of your Dist-Tof. More...
 
def command (self, command)
 Writes a value to the command register. More...
 
def get_distance_mm (self)
 Reads the distance in millimeters returns integer.
 
def get_distance_inches (self)
 Reads the distance in inches returns float.
 
- Public Member Functions inherited from lib.mindsensors.SPIKEi2c
def __init__ (self, port, i2c_address, bitrate=100)
 
def readByte (self, reg)
 Read the byte from reg of the i2c device. More...
 
def readArray (self, reg, len)
 read len long data array at reg of the i2c device More...
 
def writeByte (self, reg, value)
 write value at reg of the i2c device More...
 
def writeArray (self, reg, arr)
 write data array at reg of the i2c device More...
 
def readString (self, reg, length)
 Read the string of len from reg of the i2c device. More...
 
def readInteger (self, reg)
 Read the int from reg of the i2c device. More...
 
def readIntegerSigned (self, reg)
 Read the signed int from reg of the i2c device. More...
 
def readLong (self, reg)
 Read the long from reg of the i2c device. More...
 
def GetFirmwareVersion (self)
 Read the firmware version of the i2c device.
 
def GetVendorName (self)
 Read the vendor name of the i2c device.
 
def GetDeviceId (self)
 Read the i2c device id.
 

Public Attributes

 dist_address
 
 port
 
- Public Attributes inherited from lib.mindsensors.SPIKEi2c
 SCL
 
 SDA
 
 address
 
 int_clk
 

Static Public Attributes

int DIST_ADDRESS = 0x2
 Default Dist-Tof I2C Address.
 
int COMMAND = 0x41
 Command Register.
 
int DISTANCE = 0x42
 Distance Register. More...
 
int VOLTAGE = 0x44
 Voltage Register. More...
 
- Static Public Attributes inherited from lib.mindsensors.SPIKEi2c
int int_clk = -1
 

Constructor & Destructor Documentation

◆ __init__()

def lib.mindsensors.DIST.__init__ (   self,
  port,
  dist_address = DIST_ADDRESS 
)

Initialize the class with the i2c address of your Dist-Tof.

Parameters
dist_addressAddress of your Dist-Tof. skip if default

Member Function Documentation

◆ command()

def lib.mindsensors.DIST.command (   self,
  command 
)

Writes a value to the command register.

Parameters
commandValue to write to the command register.

Member Data Documentation

◆ DISTANCE

int lib.mindsensors.DIST.DISTANCE = 0x42
static

Distance Register.

Will return an integer value

◆ VOLTAGE

int lib.mindsensors.DIST.VOLTAGE = 0x44
static

Voltage Register.

Will return an integer value


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