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
Revision 0:38c206f19bb7, committed 2016-04-11
- Comitter:
- MikkoZ
- Date:
- Mon Apr 11 08:26:39 2016 +0000
- Child:
- 1:4d6dc19a2347
- Commit message:
- Added initial version of i2C HAL
Changed in this revision
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/.gitignore Mon Apr 11 08:26:39 2016 +0000 @@ -0,0 +1,39 @@ +# Object files +*.o +*.ko +*.obj +*.elf + +# Precompiled Headers +*.gch +*.pch + +# Libraries +*.lib +*.a +*.la +*.lo + +# Shared objects (inc. Windows DLLs) +*.dll +*.so +*.so.* +*.dylib + +# Executables +*.exe +*.out +*.app +*.i*86 +*.x86_64 +*.hex + +# Debug files +*.dSYM/ + +# Yotta files +yotta_modules/ +yotta_targets/ +build/ +upload.tar.gz +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.md Mon Apr 11 08:26:39 2016 +0000 @@ -0,0 +1,3 @@ +# rohm-sensor-hal +Platform HAL for rohm sensor drivers. Used for abstracting Arduino/mbed os/mbed classic. +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/module.json Mon Apr 11 08:26:39 2016 +0000
@@ -0,0 +1,17 @@
+{
+ "name": "rohm-sensor-hal",
+ "version": "0.0.0",
+ "description": "Rohm HAL for sensor driver development",
+ "keywords": [
+ "rohm",
+ "hal"
+ ],
+ "author": "Mikko Koivunen",
+ "repository": {
+ "url": "",
+ "type": "git"
+ },
+ "license": "Apache-2.0",
+ "dependencies": {}
+}
+
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/rohm-sensor-hal/I2CCommon.h Mon Apr 11 08:26:39 2016 +0000 @@ -0,0 +1,32 @@ +/* Copyright 2016 Rohm Semiconductor + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +*/ +#ifndef i2c_common_h +#define i2c_common_h +/* i2c common functions + This interface is the same for Arduino hardware i2c lib Wire, Arduino software i2c lib SoftI2CMaster and mbed hardware lib I2C. + Choosing between them is done by compile time using flags, for mbed use USE_MBED_HARDWARE_I2C -flag. + Note: This method doesn't allow multiple i2c busses to be used at same time. +*/ +#include "rohm_hal.h" //types, DEBUG_print*, USE_*_HARDWARE_I2C + +bool I2CCommonBegin(); +uint8_t read_register(uint8_t sad, uint8_t reg, uint8_t* buf, uint8_t buf_len); +void write_registers(uint8_t sad, uint8_t reg, uint8_t* data, uint8_t data_len); +void write_register(uint8_t sad, uint8_t reg, uint8_t data); +bool change_bits(uint8_t sad, uint8_t reg, uint8_t mask, uint8_t bits); + +#endif + +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/rohm-sensor-hal/rohm_hal.h Mon Apr 11 08:26:39 2016 +0000
@@ -0,0 +1,49 @@
+/* Copyright 2016 Rohm Semiconductor
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+*/
+#ifndef ROHM_HAL_H
+#define ROHM_HAL_H
+
+/* This file is meant for making same code work on many platforms easier. */
+#ifdef __MBED__
+ #include "mbed.h" //types
+
+ #define USE_MBED_HARDWARE_I2C
+ extern Serial pc;
+ //Serial pc(USBTX, USBRX); done in main.cpp
+ #define DEBUG_print(...) pc.printf(__VA_ARGS__)
+ #define DEBUG_printf(...) pc.printf(__VA_ARGS__)
+ #define DEBUG_println(...) pc.printf(__VA_ARGS__);pc.printf("\r\n")
+
+#elif __ARDUINO__
+ #include <arduino.h> //types, Serial
+
+ //#define USE_ARDUINO_SOFTWARE_I2C
+ #define USE_ARDUINO_HARDWARE_I2C
+
+ #define DEBUG_printf(a) Serial.print(a)
+ #define DEBUG_printf(a, b) Serial.print(a);Serial.print(b)
+ #define DEBUG_printf(a, b, c) Serial.print(a);Serial.print(b);Serial.print(c)
+ #define DEBUG_printf(a, b, c, ...) Serial.print(a);Serial.print(b);Serial.print(c)
+ #define DEBUG_print() Serial.print()
+ #define DEBUG_println() Serial.println()
+#endif
+
+#if 0 //Enable/disable debug prints
+ #define DEBUG_print()
+ #define DEBUG_printf()
+ #define DEBUG_println()
+#endif
+
+#endif /* ROHM_HAL_H */
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/source/I2CCommonMbedHardwareLib.cpp Mon Apr 11 08:26:39 2016 +0000
@@ -0,0 +1,76 @@
+/* Copyright 2016 Rohm Semiconductor
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+*/
+#include "../rohm-sensor-hal/rohm_hal.h" //types, USE_MBED_HARDWARE_I2C, DEBUG_print*, I2C_SDA, I2C_SCL
+#ifdef USE_MBED_HARDWARE_I2C
+#include "../rohm-sensor-hal/I2CCommon.h" //prototypes
+#include "I2C.h" //I2C
+#define I2C_WRITE 0
+#define I2C_READ 1
+I2C i2c(I2C_SDA, I2C_SCL);
+
+
+//Note that I2CCommonBegin() must be called before using read/write functions.
+bool I2CCommonBegin(){
+ return( true ); //always succeeds
+}
+
+/* i2c common functions */
+uint8_t read_register(uint8_t sad, uint8_t reg, uint8_t* buf, uint8_t buf_len) {
+ uint8_t received_bytes;
+ int read_ok;
+
+ i2c.write( (int)((sad << 1) | I2C_WRITE), (char*)®, (int)1 );
+ read_ok = i2c.read( (int)((sad << 1) | I2C_READ), (char*)buf, (int)buf_len);
+
+ if( read_ok == 0 ){ //0 == success(ack)
+ received_bytes = buf_len;
+ }
+ else{ //non0 == fail (nack)
+ received_bytes = 0;
+ }
+ return( received_bytes );
+}
+
+void write_registers(uint8_t sad, uint8_t reg, uint8_t* data, uint8_t data_len) {
+ i2c.write( (int)((sad << 1) | I2C_WRITE ), (char*)®, (int)1, true);
+ i2c.write( (int)((sad << 1) | I2C_WRITE ), (char*)data, (int)data_len, false);
+}
+
+void write_register(uint8_t sad, uint8_t reg, uint8_t data) {
+ char data_to_send[2];
+
+ data_to_send[0] = reg;
+ data_to_send[1] = data;
+ i2c.write( (int)((sad << 1) | I2C_WRITE ), &data_to_send[0], 2);
+}
+
+bool change_bits(uint8_t sad, uint8_t reg, uint8_t mask, uint8_t bits){
+ uint8_t value, read_bytes;
+ 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;
+ }
+ else{
+ //DEBUG_printf("Read before change_bits() failed.");
+ return false;
+ }
+}
+
+#endif
+
+
