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 Rohm

Files at this revision

API Documentation at this revision

Comitter:
MikkoZ
Date:
Thu Oct 06 10:33:05 2016 +0000
Parent:
11:272713c9e118
Child:
13:3d4508874121
Commit message:
Change_bits bugfix and highspeed functions.; ; - change_bit returnvalue inverted; - write return values added; - New functions for setting up highspeed 3.4MHz mode; ; Compiles, but not tested yet beyond basic read/write/change.

Changed in this revision

RegisterWriter/RegisterWriter.h Show annotated file Show diff for this revision Revisions of this file
source/RegisterWriter.cpp Show annotated file Show diff for this revision Revisions of this file
--- 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();
+
 };
 
 
--- a/source/RegisterWriter.cpp	Mon Oct 03 13:47:05 2016 +0000
+++ b/source/RegisterWriter.cpp	Thu Oct 06 10:33:05 2016 +0000
@@ -67,34 +67,52 @@
     return( received_bytes );
 }
 
-void RegisterWriter::write_register(uint8_t sad, uint8_t reg, uint8_t* data, uint8_t data_len) {
-    i2c_bus.write( (int)((sad << 1) | I2C_WRITE ), (char*)&reg, (int)1, true);
-    i2c_bus.write( (int)((sad << 1) | I2C_WRITE ), (char*)data, (int)data_len, false);
+uint8_t RegisterWriter::hs_read_register(uint8_t sad, uint8_t reg, uint8_t* buf, uint8_t buf_len) {
+    set_hs_mode_for_one_command();
+    //Next read command as usual, but in highspeed
+    return read_fifo_register(sad, reg, buf, buf_len);
 }
 
-void RegisterWriter::write_register(uint8_t sad, uint8_t reg, uint8_t data) {
+bool RegisterWriter::write_register(uint8_t sad, uint8_t reg, uint8_t* data, uint8_t data_len) {
+    bool error;
+    error = i2c_bus.write( (int)((sad << 1) | I2C_WRITE ), (char*)&reg, (int)1, true);
+    error = error || i2c_bus.write( (int)((sad << 1) | I2C_WRITE ), (char*)data, (int)data_len, false);
+    return error;
+}
+
+bool RegisterWriter::write_register(uint8_t sad, uint8_t reg, uint8_t data) {
     char data_to_send[2];
+    bool error;
 
     data_to_send[0] = reg;
     data_to_send[1] = data;
-    i2c_bus.write( (int)((sad << 1) | I2C_WRITE ), &data_to_send[0], 2);
+    error = i2c_bus.write( (int)((sad << 1) | I2C_WRITE ), &data_to_send[0], 2);
+
+    return error;
 }
 
 bool RegisterWriter::change_bits(uint8_t sad, uint8_t reg, uint8_t mask, uint8_t bits){
     uint8_t value, read_bytes;
+    bool error;
     read_bytes = read_register(sad, reg, &value, 1);
     if( read_bytes != 0 ){
         value = value & ~mask;
         value = value | (bits & mask);
-        write_register(sad, reg, value);
-        return true;
+        return write_register(sad, reg, value);
         }
     else{
         //DEBUG_printf("Read before change_bits() failed.");
-        return false;
+        return true;
         }
 }
 
+void RegisterWriter::set_hs_mode_for_one_command(){
+    #define MCODE (1<<3)
+    char temp;
+    //Fullspeed mode -> highspeed mode for one command.
+    i2c_bus.write( (int)(MCODE), (char*)&temp, (int)0, true ); //Trick to write just mcode+make nack.
+    }
+
 
 #endif