Class for making communication easier from code to i2c connected Rohm/Kionix sensors. Maybe could be used later also for abstracting Arduino/mbed os. Code ported from 'C'-library rohm-sensor-hal.
Dependents: kionix-kx123-hello rohm-bh1790glc-hello simple-sensor-client rohm-SensorShield-example
Fork of rohm-sensor-hal by
Diff: RegisterWriter/RegisterWriter.h
- Revision:
- 12:bc2446aabbfe
- Parent:
- 9:51c7b97b6a7d
- Child:
- 13:3d4508874121
--- a/RegisterWriter/RegisterWriter.h Mon Oct 03 13:47:05 2016 +0000
+++ b/RegisterWriter/RegisterWriter.h Thu Oct 06 10:33:05 2016 +0000
@@ -60,13 +60,23 @@
uint8_t read_fifo_register(uint8_t sad, uint8_t reg, uint8_t* buf, uint8_t buf_len);
/**
+ * Read @buf_len value(s) in high speed to @*buf from sensor @reg in address @sad.
+ * Reference to kx123 specification page 24, hs 3.4mhZ mode.
+ * @param sad Slave address of sensor
+ * @param reg Register of sensor
+ * @param *buf uint8_t[@buf_len] for read data
+ * @param buf_len amount of data to read from @reg
+ */
+ uint8_t hs_read_register(uint8_t sad, uint8_t reg, uint8_t* buf, uint8_t buf_len);
+
+ /**
* Write @data_len value(s) from @*data to sensor @reg in address @sad.
* @param sad Slave address of sensor
* @param reg Register of sensor
* @param *data uint8_t[@data_len] for written data
* @param data_len amount of data to written to @reg
*/
- void write_register(uint8_t sad, uint8_t reg, uint8_t* data, uint8_t data_len);
+ bool write_register(uint8_t sad, uint8_t reg, uint8_t* data, uint8_t data_len);
/**
* Write 1 value from @data to sensor @reg in address @sad.
@@ -74,7 +84,16 @@
* @param reg Register of sensor
* @param data to be written
*/
- void write_register(uint8_t sad, uint8_t reg, uint8_t data);
+ bool write_register(uint8_t sad, uint8_t reg, uint8_t data);
+
+ /**
+ * Write @data_len value(s) in high speed from @*data to sensor @reg in address @sad.
+ * @param sad Slave address of sensor
+ * @param reg Register of sensor
+ * @param *data uint8_t[@data_len] for written data
+ * @param data_len amount of data to written to @reg
+ */
+ bool hs_write_register(uint8_t sad, uint8_t reg, uint8_t* data, uint8_t data_len);
/**
* Read-change-write register (@sad/@reg)
@@ -82,12 +101,16 @@
* @param reg Register of sensor
* @param mask bits to clear before applying new @bits
* @param bits value to write
+ * @return true on error, false on ok
*/
bool change_bits(uint8_t sad, uint8_t reg, uint8_t mask, uint8_t bits);
private:
I2C i2c_bus;
bool self_created_i2c;
+
+ void set_hs_mode_for_one_command();
+
};
