Merge branch 'master' into feat/detailed_comment

Author: chibiegg

.travis.yml

@@ -23,6 +23,7 @@ script:
   - arduino --verify --board arduino:avr:uno $PWD/examples/Shell/Shell.ino
   - arduino --verify --board arduino:avr:uno $PWD/examples/Standard/Standard.ino
   - arduino --verify --board arduino:avr:uno $PWD/examples/CdS/CdS.ino
+  - arduino --verify --board arduino:avr:uno $PWD/examples/double2float/double2float.ino
 notifications:
   email:
     on_success: change

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 SAKURA Internet Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -169,7 +169,11 @@ Please see example code.
 * [Shell](./examples/Shell/Shell.ino)
 * [Send illminance (CdS)](./examples/CdS/CdS.ino)
 
+# Notes
 
+* On the Uno and other ATMEGA based boards, Values ​​of type double are sent as float type. (Please see [Arduino Reference]( https://www.arduino.cc/reference/en/language/variables/data-types/double/).)
+
+* Please use SakuraIOUtils::double2float() when you want to handle the value of double type received as float. DO NOT USE C type casting. (Please see [the example](./examples/double2float/double2float.ino))
 
 # License
 

examples/double2float/double2float.ino

@@ -0,0 +1,33 @@
+#include <SakuraIO.h>
+#include <SakuraIOUtils.h>
+
+//SakuraIO_SPI sakuraio(10);
+SakuraIO_I2C sakuraio;
+
+void setup(){
+
+}
+
+void loop(){
+  uint8_t ret;
+
+  uint8_t channel;
+  uint8_t type;
+  uint8_t values[8];
+  int64_t offset;
+  ret = sakuraio.dequeueRx(&channel, &type, values, &offset);
+
+  if (ret != 0x01) {
+    return;
+  }
+
+  if (type == 'd') {
+    float f = SakuraIOUtils::double2float(*((uint64_t *)values));
+
+    // On the Uno and other ATMEGA based boards, this occupies 4 bytes.
+    // That is, the double implementation is exactly the same as the float.
+    // DO NOT USE C type casting.
+    // double d = *((double *)values); // bad
+    // float f = (float)*((double *)values); // bad
+  }
+}

library.properties

@@ -1,10 +1,10 @@
 name=SakuraIO
-version=1.1.4
+version=1.1.5
 author=SAKURA Internet Inc. <support@sakura.ad.jp>
 maintainer=chibiegg <y-egusa@sakura.ad.jp>
 sentence=Library for Sakura Communication Module (https://sakura.io/)
 paragraph=Provides functions for "sakura.io" (IoT platform of SAKURA Internet Inc.) (https://sakura.io/) with Sakura Communication Module. This library supports SCM-LTE-Beta and SCM-LTE-01.
 category=Communication
 url=https://github.com/sakuraio/SakuraIOArduino
 architectures=*
-includes=SakuraIO.h
+includes=SakuraIO.h,SakuraIOUtils.h

src/SakuraIO.cpp

@@ -164,6 +164,18 @@ uint8_t SakuraIO::enqueueTx(uint8_t ch, float value, uint64_t offset){
 }
 
 uint8_t SakuraIO::enqueueTx(uint8_t ch, double value, uint64_t offset){
+
+  // check sizeof(double)
+  //
+  // On the Uno and other ATMEGA based boards,
+  // this occupies 4 bytes. That is, the double
+  // implementation is exactly the same as the float,
+  // with no gain in precision.
+  // https://www.arduino.cc/reference/en/language/variables/data-types/double/
+  if (sizeof(double) == 4){
+    return enqueueTx(ch, (float)value, offset);
+  }
+
   return enqueueTxRaw(ch, 'd', 8, (uint8_t *)&value, offset);
 }
 

src/SakuraIOUtils.cpp

@@ -0,0 +1,21 @@
+#include "SakuraIOUtils.h"
+
+namespace SakuraIOUtils {
+
+  float double2float(uint64_t d){
+
+    uint8_t sign = d>>63;
+    uint32_t exponent = (d>>52) & 0x7ff;
+    uint64_t fraction = d & 0xfffffffffffff;
+
+
+    uint32_t fv = 0;
+    fv |= (uint32_t)sign << 31;
+    fv |= (uint32_t)(exponent>>3)<<23;
+    fv |= (uint32_t)(fraction>>29);
+
+    float *pf = (float *)&fv;
+    return *pf;
+  }
+
+}

src/SakuraIOUtils.h

@@ -0,0 +1,10 @@
+#ifndef _SAKURAIOUTILS_H_
+#define _SAKURAIOUTILS_H_
+
+#include <stdint.h>
+
+namespace SakuraIOUtils {
+  float double2float(uint64_t d);
+}
+
+#endif // _SAKURAIOUTILS_H_

src/SakuraIO_I2C.cpp

@@ -19,7 +19,7 @@ void SakuraIO_I2C::end(){
       Wire.endTransmission();
       break;
     case MODE_READ:
-      Wire.requestFrom(SAKURAIO_SLAVE_ADDR, 1, true);
+      Wire.requestFrom((uint8_t)SAKURAIO_SLAVE_ADDR, (uint8_t)1, (uint8_t)true);
       if( Wire.available() ) Wire.read();
       break;
   }

src/SakuraIO_SPI.cpp

@@ -1,13 +1,14 @@
+#include <Arduino.h>
 #include <SPI.h>
 #include "SakuraIO.h"
 #include "SakuraIO/debug.h"
 
-#if SPI_HAS_TRANSACTION
+#ifdef SPI_HAS_TRANSACTION
 static SPISettings settings;
 #endif
 
 void SakuraIO_SPI::begin(){
-#if SPI_HAS_TRANSACTION
+#ifdef SPI_HAS_TRANSACTION
   SPI.beginTransaction(settings);
 #endif
   dbgln("CS=0");
@@ -17,7 +18,7 @@ void SakuraIO_SPI::begin(){
 void SakuraIO_SPI::end(){
   dbgln("CS=1");
   digitalWrite(cs, HIGH);
-#if SPI_HAS_TRANSACTION
+#ifdef SPI_HAS_TRANSACTION
   SPI.endTransaction();
 #endif
   delayMicroseconds(20);
@@ -47,7 +48,7 @@ uint8_t SakuraIO_SPI::receiveByte(){
 SakuraIO_SPI::SakuraIO_SPI(int _cs){
   cs = _cs;
   SPI.begin();
-#if SPI_HAS_TRANSACTION
+#ifdef SPI_HAS_TRANSACTION
   settings = SPISettings(350000, MSBFIRST, SPI_MODE0); // 350kHz, MSB First, SPI mode 0
 #endif
   pinMode(cs, OUTPUT);