Improving the binding to the `Serial` object and fix SoftwareSerial bug #20

heX16 · 2021-03-03T19:43:11Z

Consider the following situations:

We use another MCU (not known to this library) where the set of parameters for Serial.init(...) is different (this situation already happened with ESP32).
We use our own implementation of Serial inherited from Stream (such as AltSoftSerial).
Pin numbers in Serial can change on the fly (cofigure via web interface).
We have a dust sensor and another sensor (of another type) connected to the same SoftwareSerial, but responding to a different query format. This configuration is valid, and saving pins - is a common phenomenon. (similar to the situation in Need option to disable sending command to sensor (active_mode option) #5)
We have 16 sensors that need to be polled. For example these are compressed air lines in industry.

In the current implementation of the library it is problematic to solve these problems (without modifying the library code).
So I decided to expand PR and add more general mechanisms.

In normal projects, the problem of creating objects is solved through the "factory" pattern, but for MK this is superfluous.

It will take some more time to develop (more examples need to be written) and hopefully everyone will like the result.

Russian:
Рассмотрим следующие ситуации:

Мы используем другой МК (не известный этой библиотеке), в котором набор параметров для Serial.init(...) отличается (такая ситуация уже произошла с ESP32).
Мы используем свою собственную реализацию Serial унаследованную от Stream (например AltSoftSerial)..
Номера пин у SoftwareSerial изменяются на лету (кофигурация через web-интерфейс).
У нас датчик пыли и еще один датчик (другого типа) подключенный к этому же SoftwareSerial, но отвечающий на другой формат запроса. Такая конфигурация валидна, и экономия пинов это обычное явление. (похоже на ситуацию в Need option to disable sending command to sensor (active_mode option) #5)
У нас 16 датчиков которые нужно опрашивать. Например это линии сжатого воздуха в промышленности.

В текущей реализации библиотеки решить эти проблемы (без внесения изменений в код библиотеки) проблематично.
Поэтому я решил расширить PR и добавить более общие механизмы.

В обычных проектах проблему создания объектов решают через патерн "фабрика", но для МК это излишне.

Разработка займет еще некоторое время (нужно написать дополнительные примеры) и надеюсь результат понравится всем.

Changes

Core:

SoftwareSerial bug - #19
Improving the binding to the Serial object

ADD: "lib_dir = ../../../" - this is a dirty hack to make projects use the local library to which they belong (PlatformIO did not have the right option) ADD: special "ifdef" for ESP32 (It is possible to create a universal code for this MC. Maybe I'll do it later.) DEL: "lib_deps = EspSoftwareSerial@>=6.7.1" - this lib integrated to Arduino-ESP8266-framework. See: plerup/espsoftwareserial#200

heX16 · 2021-03-03T20:19:21Z

heX16 · 2021-03-03T20:20:25Z

Working: https://www.instagram.com/p/CL91-rrHANP/

(i use two SoftwareSerial - for CO2 sensor and PM5003 sensor.

avaldebe · 2021-03-04T08:32:31Z

Looks like the platformio travis integration now uses Python 3.7, it was 2.7 when I set it up.

In any case, I updated .travis.yml (a0e326e) which fix most of the builds.
The examples/OLED_64x48 is still crashing, looks like the ESP8266_SSD1306 library is no longer available.

avaldebe · 2021-03-04T08:37:58Z

The examples/OLED_64x48 is still crashing, looks like the ESP8266_SSD1306 library is no longer available.

The ESP8266_SSD1306 library changed name to ESP8266 and ESP32 OLED driver for SSD1306 displays

avaldebe

You can add a new constructor SerialPM(PMS sensor, SoftwareSerial &serial) if you think it is necessary,
but please keep the SerialPM(PMS sensor, uint8_t rx, uint8_t tx) constructor.

src/PMserial.h

examples/SoftwareSerial/SoftwareSerial.ino

avaldebe · 2021-03-04T09:11:22Z

The ESP8266_SSD1306 library changed name to ESP8266 and ESP32 OLED driver for SSD1306 displays

Fixed on 5e9de28. Please update your branch, so the builds succeed

heX16 · 2021-03-10T17:18:55Z

Work in progress... (see topic)

…x)` (see: #20 (review)) ADD: manual mode - constructor `SerialPM(PMS sensor)` (work in progress!) UPD: `hwSerial` - change to enum ADD: getter/setter for `uart` variable. (setSerialPort, getSerialPort) UPD: `SerialPM::init()` - updating for manual mode FIX: `SerialPM::trigRead()` - add `#ifdef` for `listen`

avaldebe

This is a minor gripe, I can add back these comments at a later stage

avaldebe · 2021-03-11T07:47:29Z

examples/SoftwareSerial/platformio.ini


 [env]
 framework = arduino

 [env:uno]
-; ATmega328, 5V/16MHz


Please leave the comments like this one, I find them useful to keep track of what each env support

Unfortunately PlatformIO erases comments when you change a file from GUI. I hope they ever fix this bug.

I can add back these comments at a later stage

You can use custom fields in environment sections. Just add custom_ prefix.

platformio/platformio-core#3862 (comment)

Thanks, I'll do that whenever I came around to add the comments back

avaldebe · 2021-03-11T07:47:41Z

examples/SoftwareSerial/platformio.ini

 platform = atmelavr
 board = uno

 [env:mini168_3V3]
-; ATmega168, 3.3V/8MHz


avaldebe · 2021-03-11T07:47:48Z

examples/SoftwareSerial/platformio.ini

 platform = atmelavr
 board = pro8MHzatmega168

 [env:mini328_3V3]
-; ATmega328, 3.3V/8MHz


avaldebe · 2021-03-11T07:47:55Z

examples/SoftwareSerial/platformio.ini

 platform = atmelavr
 board = pro8MHzatmega328

 [env:esp01]
-; ESP8266, 512kB flash


avaldebe · 2021-03-11T07:48:03Z

examples/SoftwareSerial/platformio.ini

 board = esp01
 build_flags = -D PMS_RX=2 -D PMS_TX=0

 [env:d1_mini]
-; ESP8266, 4096kB flash


avaldebe · 2021-03-11T07:55:56Z

Thanks for this PR. I learned something the Atmel AVR C++ compiler and the code got better.

Thanks again,
Á.

heX16 added 2 commits March 3, 2021 22:35

FIX: SoftwareSerial bug - #19

44eb923

avaldebe requested changes Mar 4, 2021

View reviewed changes

src/PMserial.h Show resolved Hide resolved

examples/SoftwareSerial/SoftwareSerial.ino Show resolved Hide resolved

Merge branch 'master' of https://github.com/avaldebe/PMserial

951b386

heX16 added 2 commits March 10, 2021 21:09

FIX: small fix for ESP32

6e9f2d9

heX16 changed the title ~~FIX: SoftwareSerial bug~~ SoftwareSerial bug, and improving the binding to the Serial object Mar 10, 2021

heX16 changed the title ~~SoftwareSerial bug, and improving the binding to the Serial object~~ Improving the binding to the Serial object and fix SoftwareSerial bug Mar 10, 2021

avaldebe approved these changes Mar 11, 2021

View reviewed changes

avaldebe merged commit 4f1c858 into avaldebe:master Mar 11, 2021

avaldebe mentioned this pull request Mar 11, 2021

SoftwareSerial bug - local variable, dangling pointer #19

Closed

avaldebe mentioned this pull request Mar 18, 2021

Once add "TridentTD_LineNotify" library to the project PMserial would give Exception(3) #21

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improving the binding to the `Serial` object and fix SoftwareSerial bug #20

Improving the binding to the `Serial` object and fix SoftwareSerial bug #20

heX16 commented Mar 3, 2021 •

edited

Loading

heX16 commented Mar 3, 2021

heX16 commented Mar 3, 2021 •

edited

Loading

avaldebe commented Mar 4, 2021

avaldebe commented Mar 4, 2021

avaldebe left a comment

avaldebe commented Mar 4, 2021

heX16 commented Mar 10, 2021 •

edited

Loading

avaldebe left a comment

avaldebe Mar 11, 2021

heX16 Mar 11, 2021

heX16 Mar 11, 2021 •

edited

Loading

avaldebe Mar 11, 2021

avaldebe Mar 11, 2021

avaldebe Mar 11, 2021

avaldebe Mar 11, 2021

avaldebe Mar 11, 2021

avaldebe commented Mar 11, 2021

Improving the binding to the Serial object and fix SoftwareSerial bug #20

Improving the binding to the Serial object and fix SoftwareSerial bug #20

Conversation

heX16 commented Mar 3, 2021 • edited Loading

Changes

Core:

heX16 commented Mar 3, 2021

heX16 commented Mar 3, 2021 • edited Loading

avaldebe commented Mar 4, 2021

avaldebe commented Mar 4, 2021

avaldebe left a comment

Choose a reason for hiding this comment

avaldebe commented Mar 4, 2021

heX16 commented Mar 10, 2021 • edited Loading

avaldebe left a comment

Choose a reason for hiding this comment

avaldebe Mar 11, 2021

Choose a reason for hiding this comment

heX16 Mar 11, 2021

Choose a reason for hiding this comment

heX16 Mar 11, 2021 • edited Loading

Choose a reason for hiding this comment

avaldebe Mar 11, 2021

Choose a reason for hiding this comment

avaldebe Mar 11, 2021

Choose a reason for hiding this comment

avaldebe Mar 11, 2021

Choose a reason for hiding this comment

avaldebe Mar 11, 2021

Choose a reason for hiding this comment

avaldebe Mar 11, 2021

Choose a reason for hiding this comment

avaldebe commented Mar 11, 2021

Improving the binding to the `Serial` object and fix SoftwareSerial bug #20

Improving the binding to the `Serial` object and fix SoftwareSerial bug #20

heX16 commented Mar 3, 2021 •

edited

Loading

heX16 commented Mar 3, 2021 •

edited

Loading

heX16 commented Mar 10, 2021 •

edited

Loading

heX16 Mar 11, 2021 •

edited

Loading