From 5c5ceb68c248fb094858f784b0c3484fa7bb69d3 Mon Sep 17 00:00:00 2001 From: Jacek Banaszczyk Date: Mon, 23 Apr 2018 21:16:49 +0200 Subject: [PATCH] library.properties --- README.md | 50 +++++++++++++++++++++++++----- examples/Simple01/Simple01.vcxproj | 2 +- library.properties | 12 +++---- src/pms.cpp | 0 4 files changed, 50 insertions(+), 14 deletions(-) delete mode 100644 src/pms.cpp diff --git a/README.md b/README.md index f8a2959..4f39fc9 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,56 @@ -# Before - -Current version is under development, may be not stable enough. Please refer to the latest release: https://github.com/jbanaszczyk/pms5003/releases - # pms5003 I'm proud to present my Arduino library supporting PMS5003 Air Quality Sensor. +## Status + +### Current revision: 2.00 RC + +Not released yet as a release + +Code in repository (branch: master) is 2.00 RC +* It looks stable - development is finished +* README have to be updated +* There are some TODOs for next revisions + +### Good, stable revision: 1.00 + +Previous releases are available here: https://github.com/jbanaszczyk/pms5003/releases + +There is one interesting fork supporting ESP8266: https://github.com/riverscn/pmsx003 + +## Other boards + +Probably my library supports Plantover PMS700x, PMS300x without any problems. + +If you are interested in support of your sensor: feel free to ask. + ## Features -* Supports all Plantover PMS5003 features (sleep/wake up, passive/active modes), +* Supports all Plantover PMS5003 features (sleep/wake up, passive/active modes, hardware pins), * Probably works fine with PMS7003 and PMS3003, * Highly customizable: * Uses any serial communication library, * You have a choice to use or not to use: global variables or class instances. * Written from scratch, -* Written in modern C++. +* Written in modern C++11. + +## TODO + +* Some checks: API + * checkResetPin - check if declared reset pin works fine (if it resets the sensor) + * checkSleepPin - check if declared sleep/wake up pin works fine +* Support for platforms + * Library should support Arduino itself (not checked yet :) + * More platforms: + * PlatformIO + * CLion + * ... +* Support for boards: + * planning ESP8266 support +* Add unit tests + * I'm sorry, there are no unit tests :( + ## Preparation @@ -25,7 +61,7 @@ Let's use [DrDiettrich' fork of AltSoftSerial Library](https://github.com/DrDiet Make some connections: * **Important**: pms5003 uses 3.3V logic. Make sure your Arduino board uses 3.3V logic too, use converters if required. -* PMS5003 Pin 1: Vcc +* PMS5003 Pin 1: VCC * PMS5003 Pin 2: GND * PMS5003 Pin 4: Digital pin 9 (there is no choice, forced by AltSerial) * PMS5003 Pin 5: Digital pin 8 (there is no choice) diff --git a/examples/Simple01/Simple01.vcxproj b/examples/Simple01/Simple01.vcxproj index 3a1e50d..e7b6ce0 100644 --- a/examples/Simple01/Simple01.vcxproj +++ b/examples/Simple01/Simple01.vcxproj @@ -63,7 +63,7 @@ true true true - $(ProjectDir)..\Simple01;$(ProjectDir)..\..\src;$(ProjectDir)..\..\..\AltSoftSerial;C:\Program Files (x86)\Arduino\libraries;$(ProjectDir)..\..\..\..\libraries;C:\Program Files (x86)\Arduino\hardware\arduino\avr\libraries;C:\Program Files (x86)\Arduino\hardware\arduino\avr\cores\arduino;C:\Program Files (x86)\Arduino\hardware\arduino\avr\variants\standard;C:\Program Files (x86)\Arduino\hardware\tools\avr\avr\include\;C:\Program Files (x86)\Arduino\hardware\tools\avr\avr\include\avr\;C:\Program Files (x86)\Arduino\hardware\tools\avr\lib\gcc\avr\4.8.1\include;C:\Program Files (x86)\Arduino\hardware\tools\avr\lib\gcc\avr\4.9.2\include;C:\Program Files (x86)\Arduino\hardware\tools\avr\lib\gcc\avr\4.9.3\include;%(AdditionalIncludeDirectories) + $(ProjectDir)..\Simple01;$(ProjectDir)..\..\src;C:\Program Files (x86)\Arduino\libraries;$(ProjectDir)..\..\..\..\libraries;C:\Program Files (x86)\Arduino\hardware\arduino\avr\libraries;C:\Program Files (x86)\Arduino\hardware\arduino\avr\cores\arduino;C:\Program Files (x86)\Arduino\hardware\arduino\avr\variants\standard;C:\Program Files (x86)\Arduino\hardware\tools\avr\avr\include\;C:\Program Files (x86)\Arduino\hardware\tools\avr\avr\include\avr\;C:\Program Files (x86)\Arduino\hardware\tools\avr\lib\gcc\avr\4.8.1\include;C:\Program Files (x86)\Arduino\hardware\tools\avr\lib\gcc\avr\4.9.2\include;C:\Program Files (x86)\Arduino\hardware\tools\avr\lib\gcc\avr\4.9.3\include;%(AdditionalIncludeDirectories) $(ProjectDir)__vm\.Simple01.vsarduino.h;%(ForcedIncludeFiles) false __AVR_ATmega328p__;__AVR_ATmega328P__;F_CPU=16000000L;ARDUINO=10805;ARDUINO_AVR_UNO;ARDUINO_ARCH_AVR;__cplusplus=201103L;_VMICRO_INTELLISENSE;%(PreprocessorDefinitions) diff --git a/library.properties b/library.properties index 93bd820..4611cab 100644 --- a/library.properties +++ b/library.properties @@ -1,9 +1,9 @@ -name=pms -version=1.0.0 -author=Jacek Banaszczyk -maintainer=Jacek Banaszczyk +name=pms5003 +version=2.0.0 +author=Jacek Banaszczyk +maintainer=Jacek Banaszczyk sentence=PMS5003 Air Quality Sensor library. -paragraph=PMS 5003 and similar are Particulate Matter from Plantover. -category=Uncategorized +paragraph=PMS 5003 and similar are Particulate Sensor from Plantover. +category=Sensors url=https://github.com/jbanaszczyk/pms5003 architectures=* diff --git a/src/pms.cpp b/src/pms.cpp deleted file mode 100644 index e69de29..0000000