Michel2/ESPEasy
1
0
Fork 0
mirror of https://github.com/letscontrolit/ESPEasy.git synced 2026-07-28 04:07:47 +00:00
Code Issues Releases Activity

[PMSx003] Uncrustify .ino file

Browse Source
This commit is contained in:
TD-er
2021-10-09 15:37:52 +02:00
parent 05adb430c3
commit 0c655e6e33
1 changed files with 133 additions and 128 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/_P053_PMSx003.ino
+133 -128
View File
@@ -1,8 +1,9 @@
#include "_Plugin_Helper.h"
#ifdef USES_P053
//#######################################################################################################
//#################################### Plugin 053: Plantower PMSx003 ####################################
//#######################################################################################################
// #######################################################################################################
// #################################### Plugin 053: Plantower PMSx003 ####################################
// #######################################################################################################
//
// http://www.aqmd.gov/docs/default-source/aq-spec/resources-page/plantower-pms5003-manual_v2-3.pdf?sfvrsn=2
//
@@ -10,22 +11,21 @@
// together with a laser, count the amount of particles. These sensors have an integrated microcontroller
// that counts particles and transmits measurement data over the serial connection.
#include "src/PluginStructs/P053_data_struct.h"
#define PLUGIN_053
#define PLUGIN_ID_053 53
#define PLUGIN_NAME_053 "Dust - PMSx003"
#ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
#ifdef PLUGIN_NAME_053
#undef PLUGIN_NAME_053
#endif
#define PLUGIN_NAME_053 "Dust - PMSx003 / PMSx003ST" // 'upgrade' plugin-name
#endif // ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
#define PLUGIN_VALUENAME1_053 "pm1.0"
#define PLUGIN_VALUENAME2_053 "pm2.5"
#define PLUGIN_VALUENAME3_053 "pm10"
#define PLUGIN_VALUENAME4_053 "HCHO" // Is not set into the Values on purpose.
# include "src/PluginStructs/P053_data_struct.h"
# define PLUGIN_053
# define PLUGIN_ID_053 53
# define PLUGIN_NAME_053 "Dust - PMSx003"
# ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
# ifdef PLUGIN_NAME_053
# undef PLUGIN_NAME_053
# endif // ifdef PLUGIN_NAME_053
# define PLUGIN_NAME_053 "Dust - PMSx003 / PMSx003ST" // 'upgrade' plugin-name
# endif // ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
# define PLUGIN_VALUENAME1_053 "pm1.0"
# define PLUGIN_VALUENAME2_053 "pm2.5"
# define PLUGIN_VALUENAME3_053 "pm10"
# define PLUGIN_VALUENAME4_053 "HCHO" // Is not set into the Values on purpose.
boolean Plugin_053(uint8_t function, struct EventStruct *event, String& string)
@@ -35,104 +35,106 @@ boolean Plugin_053(uint8_t function, struct EventStruct *event, String& string)
switch (function)
{
case PLUGIN_DEVICE_ADD:
{
Device[++deviceCount].Number = PLUGIN_ID_053;
Device[deviceCount].Type = DEVICE_TYPE_SERIAL_PLUS1;
Device[deviceCount].VType = Sensor_VType::SENSOR_TYPE_TRIPLE;
Device[deviceCount].Ports = 0;
Device[deviceCount].PullUpOption = false;
Device[deviceCount].InverseLogicOption = false;
#ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
Device[deviceCount].FormulaOption = true;
Device[deviceCount].ValueCount = 4;
#else
Device[deviceCount].FormulaOption = false;
Device[deviceCount].ValueCount = 3;
#endif // ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
Device[deviceCount].SendDataOption = true;
Device[deviceCount].TimerOption = true;
Device[deviceCount].GlobalSyncOption = true;
success = true;
break;
}
{
Device[++deviceCount].Number = PLUGIN_ID_053;
Device[deviceCount].Type = DEVICE_TYPE_SERIAL_PLUS1;
Device[deviceCount].VType = Sensor_VType::SENSOR_TYPE_TRIPLE;
Device[deviceCount].Ports = 0;
Device[deviceCount].PullUpOption = false;
Device[deviceCount].InverseLogicOption = false;
# ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
Device[deviceCount].FormulaOption = true;
Device[deviceCount].ValueCount = 4;
# else // ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
Device[deviceCount].FormulaOption = false;
Device[deviceCount].ValueCount = 3;
# endif // ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
Device[deviceCount].SendDataOption = true;
Device[deviceCount].TimerOption = true;
Device[deviceCount].GlobalSyncOption = true;
success = true;
break;
}
case PLUGIN_GET_DEVICENAME:
{
string = F(PLUGIN_NAME_053);
success = true;
break;
}
{
string = F(PLUGIN_NAME_053);
success = true;
break;
}
case PLUGIN_GET_DEVICEVALUENAMES:
{
strcpy_P(ExtraTaskSettings.TaskDeviceValueNames[0], PSTR(PLUGIN_VALUENAME1_053));
strcpy_P(ExtraTaskSettings.TaskDeviceValueNames[1], PSTR(PLUGIN_VALUENAME2_053));
strcpy_P(ExtraTaskSettings.TaskDeviceValueNames[2], PSTR(PLUGIN_VALUENAME3_053));
#ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
for (uint8_t i = 0; i < 3; i++) {
ExtraTaskSettings.TaskDeviceValueDecimals[i] = 0; // Set to former default
}
// 4th ValueName and decimals not (re)set on purpose
#endif // ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
success = true;
break;
{
strcpy_P(ExtraTaskSettings.TaskDeviceValueNames[0], PSTR(PLUGIN_VALUENAME1_053));
strcpy_P(ExtraTaskSettings.TaskDeviceValueNames[1], PSTR(PLUGIN_VALUENAME2_053));
strcpy_P(ExtraTaskSettings.TaskDeviceValueNames[2], PSTR(PLUGIN_VALUENAME3_053));
# ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
for (uint8_t i = 0; i < 3; i++) {
ExtraTaskSettings.TaskDeviceValueDecimals[i] = 0; // Set to former default
}
#ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
// 4th ValueName and decimals not (re)set on purpose
# endif // ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
success = true;
break;
}
# ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
case PLUGIN_GET_DEVICEVALUECOUNT:
{
event->Par1 = PCONFIG(1) == PLUGIN_053_OUTPUT_PART ? 3 : 4;
success = true;
break;
}
#endif // ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
{
event->Par1 = PCONFIG(1) == PLUGIN_053_OUTPUT_PART ? 3 : 4;
success = true;
break;
}
# endif // ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
case PLUGIN_GET_DEVICEGPIONAMES:
{
serialHelper_getGpioNames(event);
event->String3 = formatGpioName_output(F("Reset"));
break;
}
{
serialHelper_getGpioNames(event);
event->String3 = formatGpioName_output(F("Reset"));
break;
}
case PLUGIN_WEBFORM_SHOW_CONFIG:
{
string += serialHelper_getSerialTypeLabel(event);
success = true;
break;
}
{
string += serialHelper_getSerialTypeLabel(event);
success = true;
break;
}
case PLUGIN_WEBFORM_LOAD: {
#ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
# ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
{
addFormSubHeader(F("Device"));
#ifdef PLUGIN_053_ENABLE_S_AND_T
# ifdef PLUGIN_053_ENABLE_S_AND_T
int unitModelCount = 5;
#else
# else // ifdef PLUGIN_053_ENABLE_S_AND_T
int unitModelCount = 3;
#endif // ifdef PLUGIN_053_ENABLE_S_AND_T
const __FlashStringHelper * unitModels[] = {
# endif // ifdef PLUGIN_053_ENABLE_S_AND_T
const __FlashStringHelper *unitModels[] = {
F("PMS1003 / PMS5003 / PMS7003"),
F("PMS2003 / PMS3003"),
#ifdef PLUGIN_053_ENABLE_S_AND_T
# ifdef PLUGIN_053_ENABLE_S_AND_T
F("PMS5003S"),
F("PMS5003T"),
#endif // ifdef PLUGIN_053_ENABLE_S_AND_T
# endif // ifdef PLUGIN_053_ENABLE_S_AND_T
F("PMS5003ST")
};
int unitModelOptions[] = {
PMSx003_TYPE,
PMS3003_TYPE,
#ifdef PLUGIN_053_ENABLE_S_AND_T
# ifdef PLUGIN_053_ENABLE_S_AND_T
PMSx003_TYPE_S,
PMSx003_TYPE_T,
#endif // ifdef PLUGIN_053_ENABLE_S_AND_T
# endif // ifdef PLUGIN_053_ENABLE_S_AND_T
PMSx003_TYPE_ST
};
addFormSelector(F("Sensor model"), F("p053_model"), unitModelCount, unitModels, unitModelOptions, PCONFIG(0));
}
{
addFormSubHeader(F("Output"));
const __FlashStringHelper * outputOptions[] = {
const __FlashStringHelper *outputOptions[] = {
F("Particles &micro;g/m3: pm1.0, pm2.5, pm10"),
F("Particles &micro;g/m3: pm2.5; Other: Temp, Humi, HCHO (PMS5003ST)"),
F("Particles count/0.1L: cnt1.0, cnt2.5, cnt5, cnt10 (PMS1003/5003(ST)/7003)")
@@ -141,88 +143,91 @@ boolean Plugin_053(uint8_t function, struct EventStruct *event, String& string)
addFormSelector(F("Output values"), F("p053_output"), 3, outputOptions, outputOptionValues, PCONFIG(1), true);
addFormNote(F("Manually change 'Values' names and decimals accordingly! Changing this reloads the page."));
const __FlashStringHelper * eventOptions[] = {
const __FlashStringHelper *eventOptions[] = {
F("None"),
F("Particles &micro;g/m3 and Temp/Humi/HCHO"),
F("Particles &micro;g/m3, Temp/Humi/HCHO and Particles count/0.1L")
};
int eventOptionValues[] = { PLUGIN_053_EVENT_NONE, PLUGIN_053_EVENT_PARTICLES, PLUGIN_053_EVENT_PARTCOUNT};
int eventOptionValues[] = { PLUGIN_053_EVENT_NONE, PLUGIN_053_EVENT_PARTICLES, PLUGIN_053_EVENT_PARTCOUNT };
addFormSelector(F("Events for non-output values"), F("p053_events"), 3, eventOptions, eventOptionValues, PCONFIG(2));
addFormNote(F("Only generates the 'missing' events, (taskname#temp/humi/hcho, taskname#pm1.0/pm10, taskname#cnt1.0/cnt2.5/cnt5/cnt10)."));
addFormNote(F(
"Only generates the 'missing' events, (taskname#temp/humi/hcho, taskname#pm1.0/pm10, taskname#cnt1.0/cnt2.5/cnt5/cnt10)."));
}
#endif // ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
# endif // ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
success = true;
break;
}
case PLUGIN_WEBFORM_SAVE: {
#ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
# ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
PCONFIG(0) = getFormItemInt(F("p053_model"));
PCONFIG(1) = getFormItemInt(F("p053_output"));
if ((PCONFIG(0) == PMSx003_TYPE && PCONFIG(1) == PLUGIN_053_OUTPUT_THC)
|| PCONFIG(0) == PMS3003_TYPE) { // Base models only support particle values, no use in setting other output values
if (((PCONFIG(0) == PMSx003_TYPE) && (PCONFIG(1) == PLUGIN_053_OUTPUT_THC))
|| (PCONFIG(0) == PMS3003_TYPE)) { // Base models only support particle values, no use in setting other output values
PCONFIG(1) = PLUGIN_053_OUTPUT_PART;
}
PCONFIG(2) = getFormItemInt(F("P053_events"));
#endif // ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
# endif // ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
success = true;
break;
}
case PLUGIN_INIT:
{
int8_t rxPin = CONFIG_PIN1;
int8_t txPin = CONFIG_PIN2;
const ESPEasySerialPort port = static_cast<ESPEasySerialPort>(CONFIG_PORT);
int8_t resetPin = CONFIG_PIN3;
{
int8_t rxPin = CONFIG_PIN1;
int8_t txPin = CONFIG_PIN2;
const ESPEasySerialPort port = static_cast<ESPEasySerialPort>(CONFIG_PORT);
int8_t resetPin = CONFIG_PIN3;
uint8_t Plugin_053_sensortype = 0;
uint8_t Plugin_053_sensortype = 0;
#ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
Plugin_053_sensortype = PCONFIG(0);
#endif // ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
# ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
Plugin_053_sensortype = PCONFIG(0);
# endif // ifdef PLUGIN_053_ENABLE_EXTRA_SENSORS
initPluginTaskData(event->TaskIndex, new (std::nothrow) P053_data_struct(rxPin, txPin, port, resetPin, Plugin_053_sensortype));
P053_data_struct *P053_data =
static_cast<P053_data_struct *>(getPluginTaskData(event->TaskIndex));
initPluginTaskData(event->TaskIndex, new (std::nothrow) P053_data_struct(rxPin, txPin, port, resetPin, Plugin_053_sensortype));
P053_data_struct *P053_data =
static_cast<P053_data_struct *>(getPluginTaskData(event->TaskIndex));
if (nullptr == P053_data) {
return success;
}
success = P053_data->initialized();
break;
if (nullptr == P053_data) {
return success;
}
success = P053_data->initialized();
break;
}
// The update rate from the module is 200ms .. multiple seconds. Practise
// shows that we need to read the buffer many times per seconds to stay in
// sync.
case PLUGIN_TEN_PER_SECOND:
{
P053_data_struct *P053_data =
static_cast<P053_data_struct *>(getPluginTaskData(event->TaskIndex));
{
P053_data_struct *P053_data =
static_cast<P053_data_struct *>(getPluginTaskData(event->TaskIndex));
if (nullptr != P053_data && P053_data->initialized()) {
if (P053_data->packetAvailable()) {
// Check if a complete packet is available in the UART FIFO.
addLog(LOG_LEVEL_DEBUG_MORE, F("PMSx003 : Packet available"));
success = P053_data->processData(event);
}
if ((nullptr != P053_data) && P053_data->initialized()) {
if (P053_data->packetAvailable()) {
// Check if a complete packet is available in the UART FIFO.
addLog(LOG_LEVEL_DEBUG_MORE, F("PMSx003 : Packet available"));
success = P053_data->processData(event);
}
}
break;
}
case PLUGIN_READ:
{
P053_data_struct *P053_data =
static_cast<P053_data_struct *>(getPluginTaskData(event->TaskIndex));
if ((nullptr != P053_data) && P053_data->initialized()) {
// When new data is available, return true
success = P053_data->checkAndClearValuesReceived();
break;
}
case PLUGIN_READ:
{
P053_data_struct *P053_data =
static_cast<P053_data_struct *>(getPluginTaskData(event->TaskIndex));
if (nullptr != P053_data && P053_data->initialized()) {
// When new data is available, return true
success = P053_data->checkAndClearValuesReceived();
break;
}
}
}
}
return success;
}
#endif // USES_P053