API for the Catnip Electronics I2C moisture sensor. More...

Detailed Description

ID: ims
Name: I2C Moisture Sensor
Category: liquid light temp
Manufacturer: catnip
Link: https://www.tindie.com/products/miceuz/i2c-soil-moisture-sensor/
Connection: i2c

I2C sensor which can be used to read: moisture light temperature

This sensor must run at 100 kHz

    // Instantiate a IMS instance using i2c bus 0 and default address
    upm::IMS sensor(0);
    while (shouldRun)
    {
        std::cout << "Version: "
            << sensor.get_version()
            << " light: "
            << sensor.get_light()
            << " moisture: "
            << sensor.get_moisture()
            << " temp: "
            << sensor.get_temperature()
            << " C"
            << std::endl;
        sleep(1);
    }

Public Member Functions
	IMS (int16_t i2c_bus, int16_t i2c_address=IMS_ADDRESS_DEFAULT)

virtual	~IMS ()

void	write (IMS_WR_COMMAND cmd, uint8_t wr_data)

uint16_t	read (IMS_RD_COMMAND cmd)

uint16_t	get_version ()

uint16_t	get_moisture ()

uint16_t	get_light ()

float	get_temperature ()

void	reset ()

void	reset_i2c_address (uint8_t address_new)

void	sleep ()

Constructor & Destructor Documentation

IMS	(	int16_t	i2c_bus,
		int16_t	i2c_address = `IMS_ADDRESS_DEFAULT`
	)

I2C Moisture Sensor constructor

Initialize I2C Moisture Sensor

Parameters

i2c_bus	Target I2C bus
i2c_address	Target I2C address (default is 0x20)

Returns: sensor context pointer

Exceptions

std::runtime_error if sensor initializate fails

virtual ~IMS ( )

inlinevirtual

IMS destructor

Member Function Documentation

void write	(	IMS_WR_COMMAND	cmd,
		uint8_t	wr_data
	)

Write I2C Moisture Sensor registers

Parameters

cmd	Write command
wr_data	Target data to write (only used for IMS_SET_ADDRESS)

Exceptions

std::runtime_error if I2C write command fails

Here is the call graph for this function:

uint16_t read ( IMS_RD_COMMAND cmd )

Read I2C Moisture Sensor registers

Parameters

cmd	Read command

Returns: Data returned from sensor (1 or 2 bytes depending on CMD)

Exceptions

std::runtime_error if I2C read command fails

Here is the call graph for this function:

uint16_t get_version ( )

Get sensor version

Returns: Sensor version

Exceptions

std::runtime_error if I2C read command fails

Here is the call graph for this function:

uint16_t get_moisture ( )

Get moisture reading from sensor

Returns: Unitless, relative capacitance value (moisture)

Exceptions

std::runtime_error if I2C read command fails

Here is the call graph for this function:

uint16_t get_light ( )

Get light reading from LED on device. The technical data for the I2C moisture sensor specifies a 3 second wait. Loop for 3 seconds checking the GET_BUSY register. IF the sensor is NOT ready after 3 seconds, assume there is NO light and return a max uint16_t (dark) value.