Merge pull request arduino#93 from tbowmo/master

Testmode for Micro sensor

Author: henrikekblad

libraries/MySensors/examples/MysensorMicro/MysensorMicro.ino

@@ -1,7 +1,7 @@
 // Default sensor sketch for MySensor Micro module
 // Act as a temperature / humidity sensor by default.
 //
-// If A1 is held low while powering on, it will clear eeprom (and thereby the stored nodeid)
+// If A0 is held low while powering on, it will enter testmode, which verifies all on-board peripherals
 // 
 // Battery voltage is repported as child sensorId 199, as well as battery percentage
 
@@ -10,7 +10,10 @@
 #include <Wire.h>
 #include <SI7021.h>
 #include <SPI.h>
+#include <SPIFlash.h>
 #include <EEPROM.h>  
+#include <sha204_lib_return_codes.h>
+#include <sha204_library.h>
 
 // Define a static node address, remove if you want auto address assignment
 //#define NODE_ADDRESS   3
@@ -21,15 +24,22 @@
 #define CHILD_ID_BATT  199
 
 //Pin definitions
-#define RESET_CFG_PIN  A1
+#define TEST_PIN       A0
 #define LED_PIN        A2
+#define ATSHA204_PIN   17 // A3
+
+const int sha204Pin = ATSHA204_PIN;
+atsha204Class sha204(sha204Pin);
+
 
 #define MEASURE_INTERVAL 60000
 
 // FORCE_TRANSMIT_INTERVAL, this number of times of wakeup, the sensor is forced to report all values to the controller
 #define FORCE_TRANSMIT_INTERVAL 30 
 
 SI7021 humiditySensor;
+SPIFlash flash(8, 0x1F65);
+
 MySensor gw;
 
 // Sensor messages
@@ -51,12 +61,14 @@ void setup() {
   pinMode(LED_PIN, OUTPUT);
   digitalWrite(LED_PIN, LOW);
 
-  // First check if we should boot into clear eeprom mode
-  pinMode(RESET_CFG_PIN, INPUT);
-  digitalWrite(RESET_CFG_PIN, HIGH); // Enable pullup
-  if (!digitalRead(RESET_CFG_PIN)) resetEEP();
-  digitalWrite(RESET_CFG_PIN, LOW);
+  Serial.begin(115200);
+  // First check if we should boot into test mode
+
+  pinMode(TEST_PIN,INPUT);
+  digitalWrite(TEST_PIN, HIGH); // Enable pullup
+  if (!digitalRead(TEST_PIN)) testMode();
 
+  digitalWrite(TEST_PIN,LOW);
   digitalWrite(LED_PIN, HIGH); 
 
 #ifdef NODE_ADDRESS
@@ -75,7 +87,7 @@ void setup() {
   gw.present(CHILD_ID_HUM,S_HUM);
 
   gw.present(CHILD_ID_BATT, S_POWER);
-  switchClock(1<<CLKPS2);
+  switchClock(1<<CLKPS2); // Switch to 1Mhz for the reminder of the sketch, save power.
 }
 
 
@@ -173,21 +185,6 @@ long readVcc() {
   return result; // Vcc in millivolts
 }
 
-
-/*
- * Resets eeprom to default value (while blinking LED_PIN)
- */
-void resetEEP()
-{
-  for (int i=0;i<512;i++) {
-    digitalWrite(LED_PIN, HIGH);
-    delay(100);
-    digitalWrite(LED_PIN, LOW);
-    delay(100);
-    EEPROM.write(i, 0xff);
-  }
-}
-
 void switchClock(unsigned char clk)
 {
   cli();
@@ -196,3 +193,99 @@ void switchClock(unsigned char clk)
   CLKPR = clk;  
   sei();
 }
+
+
+// Verify all peripherals, and signal via the LED if any problems.
+void testMode()
+{
+  uint8_t rx_buffer[SHA204_RSP_SIZE_MAX];
+  uint8_t ret_code;
+  byte tests = 0;
+  
+  digitalWrite(LED_PIN, HIGH); // Turn on LED.
+  
+  Serial.println(F("Testing peripherals!"));
+  Serial.print(F("-> SI7021 : ")); 
+  delay(100);
+  
+  if (humiditySensor.begin()) 
+  {
+    Serial.println(F("ok!"));
+    tests ++;
+  }
+  else
+  {
+    Serial.println(F("failed!"));
+  }
+  delay(100);
+
+  Serial.print(F("-> Flash : "));
+delay(100);
+  if (flash.initialize())
+  {
+    Serial.println(F("ok!"));
+    tests ++;
+  }
+  else
+  {
+    Serial.println(F("failed!"));
+  }
+delay(100);
+  
+  Serial.println(F("-> SHA204 : "));
+  ret_code = sha204.sha204c_wakeup(rx_buffer);
+  if (ret_code != SHA204_SUCCESS)
+  {
+    Serial.print(F("Failed to wake device. Response: ")); Serial.println(ret_code, HEX);
+  }
+  
+  if (ret_code == SHA204_SUCCESS)
+  {
+    ret_code = sha204.getSerialNumber(rx_buffer);
+    if (ret_code != SHA204_SUCCESS)
+    {
+      Serial.print(F("Failed to obtain device serial number. Response: ")); Serial.println(ret_code, HEX);
+    }
+    else
+    {
+      Serial.print(F("Device serial:   "));
+      for (int i=0; i<9; i++)
+      {
+        if (rx_buffer[i] < 0x10)
+        {
+          Serial.print('0'); // Because Serial.print does not 0-pad HEX
+        }
+        Serial.print(rx_buffer[i], HEX);
+      }
+      Serial.println();
+      tests ++;
+    }
+
+  }
+ 
+
+  Serial.println(F("Test finished"));
+  
+  if (tests == 3) 
+  {
+    Serial.println(F("Selftest ok!"));
+    while (1) // Blink OK pattern!
+    {
+      digitalWrite(LED_PIN, HIGH);
+      delay(800);
+      digitalWrite(LED_PIN, LOW);
+      delay(200);
+    }
+  }
+  else 
+  {
+    Serial.println(F("----> Selftest failed!"));
+    while (1) // Blink FAILED pattern! Rappidly blinking..
+    {
+      digitalWrite(LED_PIN, HIGH);
+      delay(100);
+      digitalWrite(LED_PIN, LOW);
+      delay(100);
+    }
+  }  
+}

libraries/SPIFlash/SPIFlash.cpp

@@ -6,6 +6,9 @@
  * Minimal modifications should allow chips that have different page size but modifications
  * DEPENDS ON: Arduino SPI library
  *
+ * Updated Jan. 5, 2015, TomWS1, modified writeBytes to allow blocks > 256 bytes and handle page misalignment.
+ * Updated Feb. 26, 2015 TomWS1, added support for SPI Transactions (Arduino 1.5.8 and above)
+ *
  * This file is free software; you can redistribute it and/or modify
  * it under the terms of either the GNU General Public License version 2
  * or the GNU Lesser General Public License version 2.1, both as
@@ -32,33 +35,47 @@ SPIFlash::SPIFlash(uint8_t slaveSelectPin, uint16_t jedecID) {
 
 /// Select the flash chip
 void SPIFlash::select() {
-  noInterrupts();
   //save current SPI settings
+#ifndef SPI_HAS_TRANSACTION
+  _SREG = SREG;
+  noInterrupts();
+#endif
   _SPCR = SPCR;
   _SPSR = SPSR;
-  //set FLASH chip SPI settings
+
+#ifdef SPI_HAS_TRANSACTION
+  SPI.beginTransaction(_settings);
+#else
+  // set FLASH SPI settings
   SPI.setDataMode(SPI_MODE0);
   SPI.setBitOrder(MSBFIRST);
-  SPI.setClockDivider(SPI_CLOCK_DIV4); //decided to slow down from DIV2 after SPI stalling in some instances, especially visible on mega1284p when RFM69 and FLASH chip both present
-  SPI.begin();
+  SPI.setClockDivider(SPI_CLOCK_DIV4); // decided to slow down from DIV2 after SPI stalling in some instances, especially visible on mega1284p when RFM69 and FLASH chip both present
+#endif
   digitalWrite(_slaveSelectPin, LOW);
 }
 
 /// UNselect the flash chip
 void SPIFlash::unselect() {
   digitalWrite(_slaveSelectPin, HIGH);
   //restore SPI settings to what they were before talking to the FLASH chip
+#ifdef SPI_HAS_TRANSACTION
+  SPI.endTransaction();
+#else  
+  SREG = _SREG;  // restore interrupts IFF they were enabled
+#endif
   SPCR = _SPCR;
   SPSR = _SPSR;
-  interrupts();
 }
 
 /// setup SPI, read device ID etc...
 boolean SPIFlash::initialize()
 {
   _SPCR = SPCR;
   _SPSR = SPSR;
+  digitalWrite(_slaveSelectPin, HIGH);
   pinMode(_slaveSelectPin, OUTPUT);
+  SPI.begin();
+  _settings = SPISettings(4000000, MSBFIRST, SPI_MODE0);
   unselect();
   wakeup();
 
@@ -185,22 +202,33 @@ void SPIFlash::writeByte(long addr, uint8_t byt) {
   unselect();
 }
 
-/// write 1-256 bytes to flash memory
+/// write multiple bytes to flash memory (up to 64K)
 /// WARNING: you can only write to previously erased memory locations (see datasheet)
 ///          use the block erase commands to first clear memory (write 0xFFs)
-/// WARNING: if you write beyond a page boundary (or more than 256bytes),
-///          the bytes will wrap around and start overwriting at the beginning of that same page
-///          see datasheet for more details
+/// This version handles both page alignment and data blocks larger than 256 bytes.
+///
 void SPIFlash::writeBytes(long addr, const void* buf, uint16_t len) {
-  command(SPIFLASH_BYTEPAGEPROGRAM, true);  // Byte/Page Program
-  SPI.transfer(addr >> 16);
-  SPI.transfer(addr >> 8);
-  SPI.transfer(addr);
-  for (uint16_t i = 0; i < len; i++)
-    SPI.transfer(((byte*) buf)[i]);
-  unselect();
+  uint16_t n;
+  uint16_t maxBytes = 256-(addr%256); // force the first set of bytes to stay within the first page
+  uint16_t offset = 0;
+  while (len>0)
+  {
+    n = (len<=maxBytes) ? len : maxBytes;
+    command(SPIFLASH_BYTEPAGEPROGRAM, true); // Byte/Page Program
+    SPI.transfer(addr >> 16);
+    SPI.transfer(addr >> 8);
+    SPI.transfer(addr);
+    for (uint16_t i = 0; i < n; i++)
+      SPI.transfer(((byte*) buf)[offset + i]);
+    unselect();
+    addr+=n; // adjust the addresses and remaining bytes by what we've just transferred.
+    offset +=n;
+    len -= n;
+    maxBytes = 256; // now we can do up to 256 bytes per loop
+  }
 }
 
+
 /// erase entire flash memory array
 /// may take several seconds depending on size, but is non blocking
 /// so you may wait for this to complete using busy() or continue doing

libraries/SPIFlash/SPIFlash.h

@@ -1,11 +1,13 @@
 /*
  * Copyright (c) 2013 by Felix Rusu <felix@lowpowerlab.com>
  * SPI Flash memory library for arduino/moteino.
- * This works with 256byte/page SPI flash memory
- * For instance a 4MBit (512Kbyte) flash chip will have 2048 pages: 256*2048 = 524288 bytes (512Kbytes)
+ * This works with 256uint8_t/page SPI flash memory
+ * For instance a 4MBit (512Kuint8_t) flash chip will have 2048 pages: 256*2048 = 524288 uint8_ts (512Kuint8_ts)
  * Minimal modifications should allow chips that have different page size but modifications
  * DEPENDS ON: Arduino SPI library
  *
+ * Updated Feb. 26, 2015 TomWS1, added support for SPI Transactions (Arduino 1.5.8 and above)
+ *
  * This file is free software; you can redistribute it and/or modify
  * it under the terms of either the GNU General Public License version 2
  * or the GNU Lesser General Public License version 2.1, both as
@@ -56,45 +58,51 @@
                                               // but no actual need to wait for completion (instead need to check the status register BUSY bit)
 #define SPIFLASH_STATUSREAD       0x05        // read status register
 #define SPIFLASH_STATUSWRITE      0x01        // write status register
-#define SPIFLASH_ARRAYREAD        0x0B        // read array (fast, need to add 1 dummy byte after 3 address bytes)
+#define SPIFLASH_ARRAYREAD        0x0B        // read array (fast, need to add 1 dummy uint8_t after 3 address uint8_ts)
 #define SPIFLASH_ARRAYREADLOWFREQ 0x03        // read array (low frequency)
 
 #define SPIFLASH_SLEEP            0xB9        // deep power down
 #define SPIFLASH_WAKE             0xAB        // deep power wake up
-#define SPIFLASH_BYTEPAGEPROGRAM  0x02        // write (1 to 256bytes)
-#define SPIFLASH_IDREAD           0x9F        // read JEDEC manufacturer and device ID (2 bytes, specific bytes for each manufacturer and device)
+#define SPIFLASH_BYTEPAGEPROGRAM  0x02        // write (1 to 256uint8_ts)
+#define SPIFLASH_IDREAD           0x9F        // read JEDEC manufacturer and device ID (2 uint8_ts, specific uint8_ts for each manufacturer and device)
                                               // Example for Atmel-Adesto 4Mbit AT25DF041A: 0x1F44 (page 27: http://www.adestotech.com/sites/default/files/datasheets/doc3668.pdf)
                                               // Example for Winbond 4Mbit W25X40CL: 0xEF30 (page 14: http://www.winbond.com/NR/rdonlyres/6E25084C-0BFE-4B25-903D-AE10221A0929/0/W25X40CL.pdf)
 #define SPIFLASH_MACREAD          0x4B        // read unique ID number (MAC)
 
 class SPIFlash {
 public:
-  static byte UNIQUEID[8];
-  SPIFlash(byte slaveSelectPin, uint16_t jedecID=0);
+  static uint8_t UNIQUEID[8];
+  SPIFlash(uint8_t slaveSelectPin, uint16_t jedecID=0);
   boolean initialize();
-  void command(byte cmd, boolean isWrite=false);
-  byte readStatus();
-  byte readByte(long addr);
+  void command(uint8_t cmd, boolean isWrite=false);
+  uint8_t readStatus();
+  uint8_t readByte(long addr);
   void readBytes(long addr, void* buf, word len);
-  void writeByte(long addr, byte byt);
+  void writeByte(long addr, uint8_t byt);
   void writeBytes(long addr, const void* buf, uint16_t len);
   boolean busy();
   void chipErase();
   void blockErase4K(long address);
   void blockErase32K(long address);
   word readDeviceId();
-  byte* readUniqueId();
+  uint8_t* readUniqueId();
 
   void sleep();
   void wakeup();
   void end();
 protected:
   void select();
   void unselect();
-  byte _slaveSelectPin;
+  uint8_t _slaveSelectPin;
   uint16_t _jedecID;
-  byte _SPCR;
-  byte _SPSR;
+  uint8_t _SPCR;
+  uint8_t _SPSR;
+  uint8_t _SREG;
+  
+#ifdef SPI_HAS_TRANSACTION
+  SPISettings _settings;
+#endif
+
 };
 
 #endif