You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
100 lines
4.0 KiB
100 lines
4.0 KiB
// -----------------------------------------------------------------------------
|
|
// Abstract I2C sensor class (other sensor classes extend this class)
|
|
// Copyright (C) 2017-2019 by Xose Pérez <xose dot perez at gmail dot com>
|
|
// -----------------------------------------------------------------------------
|
|
|
|
#if SENSOR_SUPPORT && ( I2C_SUPPORT || EMON_ANALOG_SUPPORT )
|
|
|
|
#if I2C_USE_BRZO
|
|
#define I2C_TRANS_SUCCESS 0 // All i2c commands were executed without errors
|
|
#define I2C_TRANS_ERROR_BUS_NOT_FREE 1 // Bus not free, i.e. either SDA or SCL is low
|
|
#define I2C_TRANS_ERROR_NACK_WRITE 2 // Not ACK ("NACK") by slave during write:
|
|
// Either the slave did not respond to the given slave address; or the slave did not ACK a byte transferred by the master.
|
|
#define I2C_TRANS_ERROR_NACK_READ 4 // Not ACK ("NACK") by slave during read,
|
|
// i.e. slave did not respond to the given slave address
|
|
#define I2C_TRANS_ERROR_CLOCK 8 // Clock Stretching by slave exceeded maximum clock stretching time. Most probably, there is a bus stall now!
|
|
#define I2C_TRANS_ERROR_READ_NULL 16 // Read was called with 0 bytes to be read by the master. Command not sent to the slave, since this could yield to a bus stall
|
|
#define I2C_TRANS_ERROR_TIMEOUT 32 // ACK Polling timeout exceeded
|
|
#else // Wire
|
|
#define I2C_TRANS_SUCCESS 0 // success
|
|
#define I2C_TRANS_ERROR_BUFFER_OVERLOW 1 // data too long to fit in transmit buffer
|
|
#define I2C_TRANS_ERROR_NACK_ADDRESS 2 // received NACK on transmit of address
|
|
#define I2C_TRANS_ERROR_NACK_DATA 3 // received NACK on transmit of data
|
|
#define I2C_TRANS_ERROR_OTHER 4 // other error
|
|
#endif
|
|
|
|
#pragma once
|
|
|
|
#include "BaseSensor.h"
|
|
#include "../i2c.h"
|
|
|
|
// TODO: Must inherit from I2CSensor<>, not just I2CSensor. Even with default value :(
|
|
// Perhaps I2CSensor should be alias for I2CSensorBase?
|
|
|
|
template <typename T = BaseSensor>
|
|
class I2CSensor : public T {
|
|
|
|
public:
|
|
|
|
void setAddress(unsigned char address) {
|
|
if (_address == address) return;
|
|
_address = address;
|
|
T::_dirty = true;
|
|
}
|
|
|
|
unsigned char getAddress() {
|
|
return _address;
|
|
}
|
|
|
|
// Descriptive name of the slot # index
|
|
String slot(unsigned char index) {
|
|
return static_cast<T*>(this)->description();
|
|
};
|
|
|
|
// Address of the sensor (it could be the GPIO or I2C address)
|
|
String address(unsigned char index) {
|
|
char buffer[5];
|
|
snprintf(buffer, sizeof(buffer), "0x%02X", _address);
|
|
return String(buffer);
|
|
}
|
|
|
|
protected:
|
|
|
|
// Specific for I2C sensors
|
|
unsigned char _begin_i2c(unsigned char address, size_t size, unsigned char * addresses) {
|
|
|
|
// If we have already locked this address for this sensor quit
|
|
if ((address > 0) && (address == _previous_address)) {
|
|
return _previous_address;
|
|
}
|
|
|
|
// Check if we should release a previously locked address
|
|
if ((_previous_address > 0) && (_previous_address != address)) {
|
|
i2cReleaseLock(_previous_address);
|
|
_previous_address = 0;
|
|
}
|
|
|
|
// If requesting a specific address, try to ger a lock to it
|
|
if ((0 < address) && i2cGetLock(address)) {
|
|
_previous_address = address;
|
|
return _previous_address;
|
|
}
|
|
|
|
// If everything else fails, perform an auto-discover
|
|
_previous_address = i2cFindAndLock(size, addresses);
|
|
|
|
// Flag error
|
|
if (0 == _previous_address) {
|
|
T::_error = SENSOR_ERROR_I2C;
|
|
}
|
|
|
|
return _previous_address;
|
|
|
|
}
|
|
|
|
unsigned char _previous_address = 0;
|
|
unsigned char _address = 0;
|
|
|
|
};
|
|
|
|
#endif // SENSOR_SUPPORT && I2C_SUPPORT
|