Merge pull request #13 from noerw/master

Support SAMD based boards

Author: lewapek

README.md

@@ -1,16 +1,17 @@
 # Nova Fitness SDS dust sensors arduino library
 Supports Nova Fitness SDS011, SDS021 however should work for other Nova Fitness SDS sensors as well.
-This library attempts to provide easy-to-use abstraction over [Laser Dust Sensor Control Protocol V1.3](https://cdn.sparkfun.com/assets/parts/1/2/2/7/5/Laser_Dust_Sensor_Control_Protocol_V1.3.pdf).  
-Each response coming from sensor is validated whether it has correct head, command id, checksum and tail. 
+This library attempts to provide easy-to-use abstraction over [Laser Dust Sensor Control Protocol V1.3](https://cdn.sparkfun.com/assets/parts/1/2/2/7/5/Laser_Dust_Sensor_Control_Protocol_V1.3.pdf).
+Each response coming from sensor is validated whether it has correct head, command id, checksum and tail.
 Library also handles automatic retries in case of not available / failed response from sensor.
 
 ## Quickstart
-```
+```arduino
 #include "SdsDustSensor.h"
 
 int rxPin = D1;
 int txPin = D2;
 SdsDustSensor sds(rxPin, txPin);
+// SdsDustSensor sds(Serial1); // if you are on a SAMD based board
 
 void setup() {
   Serial.begin(9600);
@@ -46,24 +47,30 @@ Communication with sensor can be handled by SoftwareSerial or HardwareSerial. Yo
 
 ### Using tx and rx pins
 Communication will be implicitly handled by SoftwareSerial.
-```
+```arduino
 int rxPin = D1;
 int txPin = D2;
 SdsDustSensor sds(rxPin, txPin); // you can tune retry mechanism with additional parameters: retryDelayMs and maxRetriesNotAvailable
 sds.begin(); // you can pass custom baud rate as parameter (9600 by default)
 ```
 
+> This constructor is not available on SAMD based boards.
+> SAMD boards should provide more than enough HardwareSerial ports / SERCOM ports.
+
 ### Explicit SoftwareSerial
-```
+```arduino
 int rxPin = D1;
 int txPin = D2;
 SoftwareSerial softwareSerial(rxPin, txPin);
 SdsDustSensor sds(softwareSerial); // you can tune retry mechanism with additional parameters: retryDelayMs and maxRetriesNotAvailable
 sds.begin(); // you can pass custom baud rate as parameter (9600 by default)
 ```
 
+> This constructor is not available on SAMD based boards.
+> SAMD boards should provide more than enough HardwareSerial ports / SERCOM ports.
+
 ### Explicit HardwareSerial
-```
+```arduino
 SdsDustSensor sds(Serial1); // passing HardwareSerial as parameter, you can tune retry mechanism with additional parameters: retryDelayMs and maxRetriesNotAvailable
 sds.begin(); // you can pass custom baud rate as parameter (9600 by default)
 ```
@@ -88,23 +95,23 @@ Additionally you can read device id from every sensor response.
 
 ### Reading PM2.5 and PM10 values
 The following function (readPm()) checks whether there is available data sent from sensor, it does not send any request to sensor so it has to be in 'active' reporting mode.
-```
+```arduino
 PmResult result = sds.readPm();
 result.pm25; // float
 result.pm10; // float
 ```
 
 ### Querying PM2.5 and PM10 values
 In opposite to above function, this one sends request to sensor and expects the response. Sensor should be in 'query' reporting mode.
-```
+```arduino
 PmResult result = sds.queryPm();
 result.pm25; // float
 result.pm10; // float
 ```
 
 ### Setting custom working period - recommended over continuous
 In order to set custom working period you need to specify single argument - duration (minutes) of the cycle. One cycle means working 30 sec, doing measurement and sleeping for ```duration-30 [sec]```. This setting is recommended when using 'active' reporting mode.
-```
+```arduino
 int cycleMinutes = 4;
 WorkingPeriodResult result = sds.setCustomWorkingPeriod(cycleMinutes);
 result.period; // 4
@@ -114,13 +121,13 @@ result.toString();
 
 ### Setting reporting mode to 'query'
 When 'query' mode is active the sensor will not send data automatically, you need to send `sds.queryPm()` command on order to measure PM values.
-```
+```arduino
 ReportingModeResult result = sds.setQueryReportingMode();
 result.mode; // MODE::QUERY
 ```
 
 ### Setting sensor state to 'sleeping'
-```
+```arduino
 WorkingStateResult result = sds.sleep();
 result.isWorking(); // false
 ```
@@ -130,12 +137,12 @@ Safe wakeup tries to perform wakeup twice to assure proper response from sensor.
 Because of the fact that sensor seems to work correctly (despite invalid response), you can use unsafe method if you don't care about the response.
 
 #### Safe wakeup
-```
+```arduino
 WorkingStateResult result = sds.wakeup();
 result.isWorking(); // true
 ```
 #### Unsafe wakeup
-```
+```arduino
 WorkingStateResult result = sds.wakeupUnsafe();
 result.isWorking(); // true
 ```

library.properties

@@ -6,5 +6,5 @@ sentence=A high-level abstaction over Sds sensors family
 paragraph=Supports Sds011, implements whole Laser Dust Sensor Control Protocol V1.3, should also work with other Sds sensors.
 category=Sensors
 url=https://github.com/lewapek/sds-dust-sensors-arduino-library
-architectures=avr,esp8266,sam
+architectures=avr,esp8266,sam,samd
 includes=SdsDustSensor.h

src/SdsDustSensor.h

@@ -35,6 +35,8 @@
 
 class SdsDustSensor {
 public:
+
+#ifndef ARDUINO_SAMD_VARIANT_COMPLIANCE // there is no SoftwareSerial available (needed) on SAMD boards.
   SdsDustSensor(int pinRx,
                 int pinTx,
                 int retryDelayMs = RETRY_DELAY_MS_DEFAULT,
@@ -53,6 +55,7 @@ class SdsDustSensor {
     maxRetriesNotAvailable(maxRetriesNotAvailable) {
       sdsStream = abstractSerial->getStream();
     }
+#endif
 
   SdsDustSensor(HardwareSerial &hardwareSerial,
                 int retryDelayMs = RETRY_DELAY_MS_DEFAULT,

src/SdsDustSensorResults.h

@@ -2,7 +2,9 @@
 #define __SDS_DUST_SENSOR_RESULTS_H__
 
 #include "SdsDustSensorCommands.h"
+#ifndef ARDUINO_SAMD_VARIANT_COMPLIANCE // there is no SoftwareSerial available (needed) on SAMD boards.
 #include <SoftwareSerial.h>
+#endif
 
 enum class Status {
   Ok, NotAvailable, InvalidChecksum, InvalidResponseId, InvalidHead, InvalidTail

src/Serials.h

@@ -1,7 +1,9 @@
 #ifndef __SDS_ABSTRACT_SERIAL_H__
 #define __SDS_ABSTRACT_SERIAL_H__
 
+#ifndef ARDUINO_SAMD_VARIANT_COMPLIANCE // there is no SoftwareSerial available (needed) on SAMD boards.
 #include <SoftwareSerial.h>
+#endif
 #include <HardwareSerial.h>
 
 namespace Serials {
@@ -34,6 +36,7 @@ namespace Serials {
     HardwareSerial &serial;
   };
 
+#ifndef ARDUINO_SAMD_VARIANT_COMPLIANCE // there is no SoftwareSerial available (needed) on SAMD boards.
   struct Software: public AbstractSerial {
     Software(SoftwareSerial &serial): serial(serial) {}
 
@@ -68,6 +71,7 @@ namespace Serials {
 
     SoftwareSerial *serial;
   };
+#endif // ARDUINO_SAMD_VARIANT_COMPLIANCE
 
 }