# doc-cache created by Octave 11.1.0
# name: cache
# type: cell
# rows: 3
# columns: 7
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 6
bme280


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 2672
 -- bme280
     BME280 pressure, temperature and humidity sensor

Methods
-------

 -- OBJ = bme280(AROBJ)
 -- OBJ = bme280(AROBJ, PROPERTYNAME, PROPERTYVALUE ....)
     Constructor to create BME280 sensor

     Inputs
     ......

     AROBJ - the arduino parent object

     PROPERTYNAME, PROPERTYVALUE - optional property name, value pairs.
     Current known properties are: Current properties are:
     I2CAddress
          I2C address of the sensor (default 0x40)
     Bus
          I2C bus - 0 or 1 (default 0)

     Outputs
     .......

     OBJ - created object

     Example
     .......


          a = arduino()
          sensor = bme280(a)

 -- [C, TIMESTAMP] = readTemperature(OBJ)
     Read the temperature

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     C - read temperature in deg C.

     TIMESTAMP - timestamp when read

     Example
     .......


          a = arduino()
          s = bme280(a)
          # get temp
          temp = s.readTemperature

     See also: bme280.

 -- [RELH, TIMESTAMP] = readHumidity(OBJ)
     Read the relative humidity

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     RELH - relative humidity as a percentage (0 - 100.0)

     TIMESTAMP - timestamp when read

 -- [P, TIMESTAMP] = readPressure(OBJ)
     Read the pressure

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     P - pressure reading from sensor.

     TIMESTAMP - timestamp when read

 -- [READINGS, OVERRUN] = read(OBJ)
 -- [P, H, C, TIMESTAMP, OVERRUN] = read(OBJ)
     Read the sensor data

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     P - pressure reading from sensor.

     H - humidity reading from sensor.

     C - temperature reading from sensor.

     TIMESTAMP - timestamp when read

     OVERRUN - overrun flag.

     READINGS - table structure with fields for Timestamp, Pressure,
     Temperature and Humidity.

 -- INF = info(OBJ)
     Read the sensor info

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     INF - structure containing the sensor information.

     Structure fields are:
     Version
          Chip firmware version
     SensorId
          sensor id value
     Type
          sensor type 'bme280'
     Status
          Status value read from sensor

 -- flush(OBJ)
     Flush sensor data

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     None

 -- release(OBJ)
     Release the resources of the sensor

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     None


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 48
BME280 pressure, temperature and humidity sensor



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 6
bno055


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 3913
 -- bno055
     BNO055 9 axis orientation sensor

Methods
-------

 -- OBJ = bno055(AROBJ)
 -- OBJ = bno055(AROBJ, PROPERTYNAME, PROPERTYVALUE ....)
     Constructor to create BME280 sensor

     Inputs
     ......

     AROBJ - the arduino parent object

     PROPERTYNAME, PROPERTYVALUE - optional property name, value pairs.
     Current known properties are: Current properties are:
     I2CAddress
          I2C address of the sensor (default 0x40)
     Bus
          I2C bus - 0 or 1 (default 0)
     OperatingMode
          Operating mode 'ndof' or 'amg'

     Outputs
     .......

     OBJ - created object

     Example
     .......


          a = arduino()
          sensor = bno055(a)

 -- [C, TIMESTAMP] = readTemperature(OBJ)
     Read the temperature

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     C - read temperature in deg C.

     TIMESTAMP - timestamp when read

     Example
     .......


          a = arduino()
          s = bno055(a)
          # get temp
          temp = s.readTemperature

     See also: bno055.

 -- [READVAL, TIMESTAMP] = readAcceleration(OBJ)
     Read the acceleration rate

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     READVAL - the 3 acceleration values

     TIMESTAMP - timestamp when read

 -- [READVAL, TIMESTAMP] = readAngularVelocity(OBJ)
     Read the angular velocity

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     READVAL - the 3 angular velocity values

     TIMESTAMP - timestamp when read

 -- [READVAL, TIMESTAMP] = readMagneticField(OBJ)
     Read the magnetic field components

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     READVAL - the 3 magnetic field values

     TIMESTAMP - timestamp when read

 -- [READVAL, TIMESTAMP] = readOrientation(OBJ)
     Read the oriientation components

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     READVAL - the 3 orientation values

     TIMESTAMP - timestamp when read

 -- [READINGS, OVERRUN] = read(OBJ)
 -- [ACCEL, GYRO, MAG, TIMESTAMP, OVERRUN] = read(OBJ)
 -- [ACCEL, GYRO, MAG, ORIENTATION, TIMESTAMP, OVERRUN] = read(OBJ)
     Read the sensor data

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     ACCEL - acceleration reading from sensor.

     GYRO - angular acceleration reading from sensor.

     MAG - magnetic field reading from sensor.

     ORIENTATION - orientation reading from sensor.

     TIMESTAMP - timestamp when read

     OVERRUN - overrun flag.

     READINGS - table structure with fields for Timestamp, Acceleration,
     AngularVelocity, MagneticField, Orientation.

 -- INF = readCalibrationStatus(OBJ)
     Read the sensor calibration status

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     STATUS - structure containing the calibration information.

     Structure fields are:
     System
          System calibrarion
     Accelerometer
          Accelerometer calibration status
     Gyroscope
          Gyroscope calibration status
     Magnetometer
          Magnetometer calibration status

     Values for each will be either 'uncalibrated', 'partial' or 'full'.

 -- INF = info(OBJ)
     Read the sensor info

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     INF - structure containing the sensor information.

     Structure fields are:
     Version
          Software firmware version
     SensorId
          sensor id value
     Type
          sensor type 'bno055'

 -- flush(OBJ)
     Flush sensor data

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     None

 -- release(OBJ)
     Release the resources of the sensor

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     None


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 32
BNO055 9 axis orientation sensor



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 6
lis3dh


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 1872
 -- lis3dh
     LIS3DH 3 degrees sensor

Methods
-------

 -- OBJ = lis3dh(AROBJ)
 -- OBJ = lis3dh(AROBJ, PROPERTYNAME, PROPERTYVALUE ....)
     Constructor to create LIS3DH sensor

     Inputs
     ......

     AROBJ - the arduino parent object

     PROPERTYNAME, PROPERTYVALUE - optional property name, value pairs.
     Current known properties are: Current properties are:
     I2CAddress
          I2C address of the sensor (default 0x40)
     Bus
          I2C bus - 0 or 1 (default 0)

     Outputs
     .......

     OBJ - created object

     Example
     .......


          a = arduino()
          sensor = lis3dh(a)

 -- [READVAL, TIMESTAMP] = readAcceleration(OBJ)
     Read the acceleration rate

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     READVAL - the 3 acceleration values

     TIMESTAMP - timestamp when read

 -- [READINGS, OVERRUN] = read(OBJ)
 -- [ACCEL, TIMESTAMP, OVERRUN] = read(OBJ)
     Read the sensor data

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     ACCEL - acceleration reading from sensor.

     TIMESTAMP - timestamp when read

     OVERRUN - overrun flag.

     READINGS - table structure with fields for Timestamp, Acceleration.

 -- INF = info(OBJ)
     Read the sensor info

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     INF - structure containing the sensor information.

     Structure fields are:
     SensorId
          sensor id value
     Type
          sensor type 'lis3dh'
     Status
          sensor status value

 -- flush(OBJ)
     Flush sensor data

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     None

 -- release(OBJ)
     Release the resources of the sensor

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     None


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 23
LIS3DH 3 degrees sensor



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 7
lps22hb


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 2383
 -- lps22hb
     LPS22HB absolute pressure and temperature sensor

Methods
-------

 -- OBJ = lps22hb(AROBJ)
 -- OBJ = lps22hb(AROBJ, PROPERTYNAME, PROPERTYVALUE ....)
     Constructor to create LPS22HB sensor

     Inputs
     ......

     AROBJ - the arduino parent object

     PROPERTYNAME, PROPERTYVALUE - optional property name, value pairs.
     Current known properties are: Current properties are:
     I2CAddress
          I2C address of the sensor (default 0x5C)
     Bus
          I2C bus - 0 or 1 (default 0)

     Outputs
     .......

     OBJ - created object

     Example
     .......


          a = arduino()
          sensor = lps22hb(a)

 -- [C, TIMESTAMP] = readTemperature(OBJ)
     Read the temperature

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     C - read temperature in deg C.

     TIMESTAMP - timestamp when read

     Example
     .......


          a = arduino()
          s = lps22hb(a)
          # get temp
          temp = s.readTemperature

     See also: lps22hb.

 -- [P, TIMESTAMP] = readPressure(OBJ)
     Read the pressure

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     P - pressure reading from sensor.

     TIMESTAMP - timestamp when read

 -- [READINGS, OVERRUN] = read(OBJ)
 -- [P, C, TIMESTAMP, OVERRUN] = read(OBJ)
     Read the sensor data

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     P - pressure reading from sensor.

     C - temperature reading from sensor.

     TIMESTAMP - timestamp when read

     OVERRUN - overrun flag.

     READINGS - table structure with fields for Timestamp, Pressure,
     Temperature and Humidity.

 -- INF = info(OBJ)
     Read the sensor info

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     INF - structure containing the sensor information.

     Structure fields are:
     Version
          Chip firmware version
     SensorId
          sensor id value
     Type
          sensor type 'lps22hb'
     Status
          Status value read from sensor

 -- flush(OBJ)
     Flush sensor data

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     None

 -- release(OBJ)
     Release the resources of the sensor

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     None


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 48
LPS22HB absolute pressure and temperature sensor



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 7
lsm6dso


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 2560
 -- lsm6dso
     LSM6DSO 6 degrees sensor

Methods
-------

 -- OBJ = lsm6dso(AROBJ)
 -- OBJ = lsm6dso(AROBJ, PROPERTYNAME, PROPERTYVALUE ....)
     Constructor to create LSM6DSO sensor

     Inputs
     ......

     AROBJ - the arduino parent object

     PROPERTYNAME, PROPERTYVALUE - optional property name, value pairs.
     Current known properties are: Current properties are:
     I2CAddress
          I2C address of the sensor (default 0x40)
     Bus
          I2C bus - 0 or 1 (default 0)

     Outputs
     .......

     OBJ - created object

     Example
     .......


          a = arduino()
          sensor = lsm6dso(a)

 -- [C, TIMESTAMP] = readTemperature(OBJ)
     Read the temperature

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     C - read temperature in deg C.

     TIMESTAMP - timestamp when read

     Example
     .......


          a = arduino()
          s = lsm6dso(a)
          # get temp
          temp = s.readTemperature

     See also: lsm6dso.

 -- [READVAL, TIMESTAMP] = readAcceleration(OBJ)
     Read the acceleration rate

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     READVAL - the 3 acceleration values

     TIMESTAMP - timestamp when read

 -- [READVAL, TIMESTAMP] = readAngularVelocity(OBJ)
     Read the angular velocity

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     READVAL - the 3 angular velocity values

     TIMESTAMP - timestamp when read

 -- [READINGS, OVERRUN] = read(OBJ)
 -- [ACCEL, GYRO, MAG, TIMESTAMP, OVERRUN] = read(OBJ)
     Read the sensor data

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     ACCEL - acceleration reading from sensor.

     GYRO - angular acceleration reading from sensor.

     TIMESTAMP - timestamp when read

     OVERRUN - overrun flag.

     READINGS - table structure with fields for Timestamp, Acceleration,
     AngularVelocity.

 -- INF = info(OBJ)
     Read the sensor info

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     INF - structure containing the sensor information.

     Structure fields are:
     SensorId
          sensor id value
     Type
          sensor type 'lsm6dso'

 -- flush(OBJ)
     Flush sensor data

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     None

 -- release(OBJ)
     Release the resources of the sensor

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     None


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 24
LSM6DSO 6 degrees sensor



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 7
mpu6050


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 2562
 -- mpu6050
     MPU-6050 6 degrees sensor

Methods
-------

 -- OBJ = mpu6050(AROBJ)
 -- OBJ = mpu6050(AROBJ, PROPERTYNAME, PROPERTYVALUE ....)
     Constructor to create MPU-6050 sensor

     Inputs
     ......

     AROBJ - the arduino parent object

     PROPERTYNAME, PROPERTYVALUE - optional property name, value pairs.
     Current known properties are: Current properties are:
     I2CAddress
          I2C address of the sensor (default 0x40)
     Bus
          I2C bus - 0 or 1 (default 0)

     Outputs
     .......

     OBJ - created object

     Example
     .......


          a = arduino()
          sensor = mpu6050(a)

 -- [C, TIMESTAMP] = readTemperature(OBJ)
     Read the temperature

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     C - read temperature in deg C.

     TIMESTAMP - timestamp when read

     Example
     .......


          a = arduino()
          s = mpu6050(a)
          # get temp
          temp = s.readTemperature

     See also: mpu6050.

 -- [READVAL, TIMESTAMP] = readAcceleration(OBJ)
     Read the acceleration rate

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     READVAL - the 3 acceleration values

     TIMESTAMP - timestamp when read

 -- [READVAL, TIMESTAMP] = readAngularVelocity(OBJ)
     Read the angular velocity

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     READVAL - the 3 angular velocity values

     TIMESTAMP - timestamp when read

 -- [READINGS, OVERRUN] = read(OBJ)
 -- [ACCEL, GYRO, MAG, TIMESTAMP, OVERRUN] = read(OBJ)
     Read the sensor data

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     ACCEL - acceleration reading from sensor.

     GYRO - angular acceleration reading from sensor.

     TIMESTAMP - timestamp when read

     OVERRUN - overrun flag.

     READINGS - table structure with fields for Timestamp, Acceleration,
     AngularVelocity.

 -- INF = info(OBJ)
     Read the sensor info

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     INF - structure containing the sensor information.

     Structure fields are:
     SensorId
          sensor id value
     Type
          sensor type 'mpu6050'

 -- flush(OBJ)
     Flush sensor data

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     None

 -- release(OBJ)
     Release the resources of the sensor

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     None


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 25
MPU-6050 6 degrees sensor



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 6
si7021


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 2355
 -- si7021
     SI7021 temperature and humidity sensor

Methods
-------

 -- OBJ = si7021(AROBJ)
 -- OBJ = si7021(AROBJ, PROPERTYNAME, PROPERTYVALUE ....)
     Constructor to create si7021 sensor

     Inputs
     ......

     AROBJ - the arduino parent object

     PROPERTYNAME, PROPERTYVALUE - optional property name, value pairs.
     Current known properties are: Current properties are:
     I2Caddress
          I2C address of the si7021 (default 0x40)
     Bus
          I2C bus (default 0)

     Outputs
     .......

     OBJ - created SI7020 object

     Example
     .......


          a = arduino()
          sensor = si7021(a)

 -- [C, TIMESTAMP] = readTemperature(OBJ)
     Read the temperature

     Inputs
     ......

     OBJ - the si7021 object

     Outputs
     .......

     C - read temperature in deg C.

     TIMESTAMP - timestamp when read

     Example
     .......


          a = arduino()
          s = si7021(a)
          # get temp
          temp = s.readTemperature()

     See also: si7021.

 -- [RELH, TIMESTAMP] = readHumidity(OBJ)
     Read the relative humidity

     Inputs
     ......

     OBJ - the si7021 object

     Outputs
     .......

     RELH - relative humidity as a percentage (0 - 100.0)

     TIMESTAMP - timestamp when read

 -- [READINGS, OVERRUN] = read(OBJ)
 -- [H, C, TIMESTAMP, OVERRUN] = read(OBJ)
     Read the sensor data

     Inputs
     ......

     OBJ - the si2071 sensor object

     Outputs
     .......

     H - humidity reading from sensor.

     C - temperature reading from sensor.

     TIMESTAMP - timestamp when read

     OVERRUN - overrun flag.

     READINGS - table structure with fields for Timestamp, Temperature
     and Humidity.

 -- RELH = info(DSOBJ)
     Read the sensor info

     Inputs
     ......

     DSOBJ - the si7021 object

     Outputs
     .......

     INF - structure containing the sensor information.

     Structure fields are:
     Version
          Chip firmware version
     SensorDd
          sensor id value
     Type
          String for detected chip type

 -- flush(OBJ)
     Flush sensor data

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     None

 -- release(OBJ)
     Release the resources of the sensor

     Inputs
     ......

     OBJ - the sensor object

     Outputs
     .......

     None


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 38
SI7021 temperature and humidity sensor





