Skip to content

Commit 6bc086b

Browse files
0hax0hax
committed
uart: Add support for specifying the number of bits and parity.
ESP8266SwSerial doesn't really check parity but just read the parity bit and ignore it when receiving data. Signed-off-by: 0hax <[email protected]>
1 parent 153aada commit 6bc086b

File tree

3 files changed

+148
-30
lines changed

3 files changed

+148
-30
lines changed

‎esphome/components/uart/__init__.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,17 @@ def validate_rx_pin(value):
2929

3030

3131
CONF_STOP_BITS = 'stop_bits'
32+
CONF_NR_BITS = 'nr_bits'
33+
CONF_PARITY = 'parity'
34+
3235
CONFIG_SCHEMA = cv.All(cv.Schema({
3336
cv.GenerateID(): cv.declare_id(UARTComponent),
3437
cv.Required(CONF_BAUD_RATE): cv.int_range(min=1),
3538
cv.Optional(CONF_TX_PIN): pins.output_pin,
3639
cv.Optional(CONF_RX_PIN): validate_rx_pin,
3740
cv.Optional(CONF_STOP_BITS, default=1): cv.one_of(1, 2, int=True),
41+
cv.Optional(CONF_NR_BITS, default=8): cv.int_range(min=5, max=8),
42+
cv.Optional(CONF_PARITY, default="none"): cv.one_of("none", "even", "odd", lower=True),
3843
}).extend(cv.COMPONENT_SCHEMA), cv.has_at_least_one_key(CONF_TX_PIN, CONF_RX_PIN))
3944

4045

@@ -50,6 +55,8 @@ def to_code(config):
5055
if CONF_RX_PIN in config:
5156
cg.add(var.set_rx_pin(config[CONF_RX_PIN]))
5257
cg.add(var.set_stop_bits(config[CONF_STOP_BITS]))
58+
cg.add(var.set_nr_bits(config[CONF_NR_BITS]))
59+
cg.add(var.set_parity(config[CONF_PARITY]))
5360

5461

5562
# A schema to use for all UART devices, all UART integrations must extend this!

‎esphome/components/uart/uart.cpp

Lines changed: 131 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,65 @@ uint8_t next_uart_num = 1;
1818
#endif
1919

2020
#ifdef ARDUINO_ARCH_ESP32
21+
22+
#define UART_PARITY_EVEN 0 << 0
23+
#define UART_PARITY_ODD 1 << 0
24+
#define UART_PARITY_EN 1 << 1
25+
#define UART_NB_BIT_5 0 << 2
26+
#define UART_NB_BIT_6 1 << 2
27+
#define UART_NB_BIT_7 2 << 2
28+
#define UART_NB_BIT_8 3 << 2
29+
#define UART_NB_STOP_BIT_1 1 << 4
30+
#define UART_NB_STOP_BIT_2 3 << 4
31+
#define UART_TICK_APB_CLOCK 1 << 27
32+
33+
uint32_t UARTComponent::get_config() {
34+
uint32_t config = 0;
35+
36+
/*
37+
* All bits numbers below come from
38+
* framework-arduinoespressif32/cores/esp32/esp32-hal-uart.h
39+
* And more specifically conf0 union in uart_dev_t.
40+
*
41+
* Below is bit used from conf0 union.
42+
* <name>:<bits position> <values>
43+
* parity:0 0:even 1:odd
44+
* parity_en:1 Set this bit to enable uart parity check.
45+
* bit_num:2-4 0:5bits 1:6bits 2:7bits 3:8bits
46+
* stop_bit_num:4-6 stop bit. 1:1bit 2:1.5bits 3:2bits
47+
* tick_ref_always_on:27 select the clock.1：apb clock：ref_tick
48+
*/
49+
50+
if (this->parity_ == "even")
51+
config |= UART_PARITY_EVEN | UART_PARITY_EN;
52+
else if (this->parity_ == "odd")
53+
config |= UART_PARITY_ODD | UART_PARITY_EN;
54+
55+
switch (this->nr_bits_) {
56+
case 5:
57+
config |= UART_NB_BIT_5;
58+
break;
59+
case 6:
60+
config |= UART_NB_BIT_6;
61+
break;
62+
case 7:
63+
config |= UART_NB_BIT_7;
64+
break;
65+
case 8:
66+
config |= UART_NB_BIT_8;
67+
break;
68+
}
69+
70+
if (this->stop_bits_ == 1)
71+
config |= UART_NB_STOP_BIT_1;
72+
else
73+
config |= UART_NB_STOP_BIT_2;
74+
75+
config |= UART_TICK_APB_CLOCK;
76+
77+
return config;
78+
}
79+
2180
void UARTComponent::setup() {
2281
ESP_LOGCONFIG(TAG, "Setting up UART...");
2382
// Use Arduino HardwareSerial UARTs if all used pins match the ones
@@ -30,10 +89,7 @@ void UARTComponent::setup() {
3089
}
3190
int8_t tx = this->tx_pin_.has_value() ? *this->tx_pin_ : -1;
3291
int8_t rx = this->rx_pin_.has_value() ? *this->rx_pin_ : -1;
33-
uint32_t config = SERIAL_8N1;
34-
if (this->stop_bits_ == 2)
35-
config = SERIAL_8N2;
36-
this->hw_serial_->begin(this->baud_rate_, config, rx, tx);
92+
this->hw_serial_->begin(this->baud_rate_, get_config(), rx, tx);
3793
}
3894

3995
void UARTComponent::dump_config() {
@@ -45,6 +101,8 @@ void UARTComponent::dump_config() {
45101
ESP_LOGCONFIG(TAG, " RX Pin: GPIO%d", *this->rx_pin_);
46102
}
47103
ESP_LOGCONFIG(TAG, " Baud Rate: %u baud", this->baud_rate_);
104+
ESP_LOGCONFIG(TAG, " Bits: %u", this->nr_bits_);
105+
ESP_LOGCONFIG(TAG, " Parity: %s", this->parity_.c_str());
48106
ESP_LOGCONFIG(TAG, " Stop bits: %u", this->stop_bits_);
49107
this->check_logger_conflict_();
50108
}
@@ -108,17 +166,46 @@ void UARTComponent::flush() {
108166
#endif // ESP32
109167

110168
#ifdef ARDUINO_ARCH_ESP8266
169+
uint32_t UARTComponent::get_config() {
170+
uint32_t config = 0;
171+
172+
if (this->parity_ == "none")
173+
config |= UART_PARITY_NONE;
174+
else if (this->parity_ == "even")
175+
config |= UART_PARITY_EVEN;
176+
else if (this->parity_ == "odd")
177+
config |= UART_PARITY_ODD;
178+
179+
switch (this->nr_bits_) {
180+
case 5:
181+
config |= UART_NB_BIT_5;
182+
break;
183+
case 6:
184+
config |= UART_NB_BIT_6;
185+
break;
186+
case 7:
187+
config |= UART_NB_BIT_7;
188+
break;
189+
case 8:
190+
config |= UART_NB_BIT_8;
191+
break;
192+
}
193+
194+
if (this->stop_bits_ == 1)
195+
config |= UART_NB_STOP_BIT_1;
196+
else
197+
config |= UART_NB_STOP_BIT_2;
198+
199+
return config;
200+
}
201+
111202
void UARTComponent::setup() {
112203
ESP_LOGCONFIG(TAG, "Setting up UART bus...");
113204
// Use Arduino HardwareSerial UARTs if all used pins match the ones
114205
// preconfigured by the platform. For example if RX disabled but TX pin
115206
// is 1 we still want to use Serial.
116-
uint32_t mode = UART_NB_BIT_8 | UART_PARITY_NONE;
117-
if (this->stop_bits_ == 1)
118-
mode |= UART_NB_STOP_BIT_1;
119-
else
120-
mode |= UART_NB_STOP_BIT_2;
121-
SerialConfig config = static_cast<SerialConfig>(mode);
207+
SerialConfig config = static_cast<SerialConfig>(get_config());
208+
122209
if (this->tx_pin_.value_or(1) == 1 && this->rx_pin_.value_or(3) == 3) {
123210
this->hw_serial_ = &Serial;
124211
this->hw_serial_->begin(this->baud_rate_, config);
@@ -133,7 +220,7 @@ void UARTComponent::setup() {
133220
this->sw_serial_ = new ESP8266SoftwareSerial();
134221
int8_t tx = this->tx_pin_.has_value() ? *this->tx_pin_ : -1;
135222
int8_t rx = this->rx_pin_.has_value() ? *this->rx_pin_ : -1;
136-
this->sw_serial_->setup(tx, rx, this->baud_rate_, this->stop_bits_);
223+
this->sw_serial_->setup(tx, rx, this->baud_rate_, this->stop_bits_, this->nr_bits_, this->parity_);
137224
}
138225
}
139226

@@ -146,6 +233,8 @@ void UARTComponent::dump_config() {
146233
ESP_LOGCONFIG(TAG, " RX Pin: GPIO%d", *this->rx_pin_);
147234
}
148235
ESP_LOGCONFIG(TAG, " Baud Rate: %u baud", this->baud_rate_);
236+
ESP_LOGCONFIG(TAG, " Bits: %u", this->nr_bits_);
237+
ESP_LOGCONFIG(TAG, " Parity: %s", this->parity_.c_str());
149238
ESP_LOGCONFIG(TAG, " Stop bits: %u", this->stop_bits_);
150239
if (this->hw_serial_ != nullptr) {
151240
ESP_LOGCONFIG(TAG, " Using hardware serial interface.");
@@ -250,8 +339,12 @@ void UARTComponent::flush() {
250339
}
251340
}
252341

253-
void ESP8266SoftwareSerial::setup(int8_t tx_pin, int8_t rx_pin, uint32_t baud_rate, uint8_t stop_bits) {
342+
void ESP8266SoftwareSerial::setup(int8_t tx_pin, int8_t rx_pin, uint32_t baud_rate, uint8_t stop_bits, uint32_t nr_bits,
343+
std::string &parity) {
254344
this->bit_time_ = F_CPU / baud_rate;
345+
this->stop_bits_ = stop_bits;
346+
this->nr_bits_ = nr_bits;
347+
this->parity_ = parity;
255348
if (tx_pin != -1) {
256349
auto pin = GPIOPin(tx_pin, OUTPUT);
257350
pin.setup();
@@ -265,21 +358,22 @@ void ESP8266SoftwareSerial::setup(int8_t tx_pin, int8_t rx_pin, uint32_t baud_ra
265358
this->rx_buffer_ = new uint8_t[this->rx_buffer_size_];
266359
pin.attach_interrupt(ESP8266SoftwareSerial::gpio_intr, this, FALLING);
267360
}
268-
this->stop_bits_ = stop_bits;
269361
}
270362
void ICACHE_RAM_ATTR ESP8266SoftwareSerial::gpio_intr(ESP8266SoftwareSerial *arg) {
271363
uint32_t wait = arg->bit_time_ + arg->bit_time_ / 3 - 500;
272364
const uint32_t start = ESP.getCycleCount();
273365
uint8_t rec = 0;
274366
// Manually unroll the loop
275-
rec |= arg->read_bit_(&wait, start) << 0;
276-
rec |= arg->read_bit_(&wait, start) << 1;
277-
rec |= arg->read_bit_(&wait, start) << 2;
278-
rec |= arg->read_bit_(&wait, start) << 3;
279-
rec |= arg->read_bit_(&wait, start) << 4;
280-
rec |= arg->read_bit_(&wait, start) << 5;
281-
rec |= arg->read_bit_(&wait, start) << 6;
282-
rec |= arg->read_bit_(&wait, start) << 7;
367+
for (int i = 0; i < arg->nr_bits_; i++)
368+
rec |= arg->read_bit_(&wait, start) << i;
369+
370+
/* If parity is enabled, just read it and ignore it. */
371+
/* TODO: Should we check parity? Or is it too slow for nothing added..*/
372+
if (arg->parity_ == "even")
373+
arg->read_bit_(&wait, start);
374+
else if (arg->parity_ == "odd")
375+
arg->read_bit_(&wait, start);
376+
283377
// Stop bit
284378
arg->wait_(&wait, start);
285379
if (arg->stop_bits_ == 2)
@@ -295,21 +389,29 @@ void ICACHE_RAM_ATTR HOT ESP8266SoftwareSerial::write_byte(uint8_t data) {
295389
ESP_LOGE(TAG, "UART doesn't have TX pins set!");
296390
return;
297391
}
392+
bool parity_bit = false;
393+
bool need_parity_bit = true;
394+
if (this->parity_ == "even")
395+
parity_bit = true;
396+
else if (this->parity_ == "odd")
397+
parity_bit = false;
398+
else
399+
need_parity_bit = false;
298400

299401
{
300402
InterruptLock lock;
301403
uint32_t wait = this->bit_time_;
302404
const uint32_t start = ESP.getCycleCount();
303405
// Start bit
304406
this->write_bit_(false, &wait, start);
305-
this->write_bit_(data & (1 << 0), &wait, start);
306-
this->write_bit_(data & (1 << 1), &wait, start);
307-
this->write_bit_(data & (1 << 2), &wait, start);
308-
this->write_bit_(data & (1 << 3), &wait, start);
309-
this->write_bit_(data & (1 << 4), &wait, start);
310-
this->write_bit_(data & (1 << 5), &wait, start);
311-
this->write_bit_(data & (1 << 6), &wait, start);
312-
this->write_bit_(data & (1 << 7), &wait, start);
407+
for (int i = 0; i < this->nr_bits_; i++) {
408+
bool bit = data & (1 << i);
409+
this->write_bit_(bit, &wait, start);
410+
if (need_parity_bit)
411+
parity_bit ^= bit;
412+
}
413+
if (need_parity_bit)
414+
this->write_bit_(parity_bit, &wait, start);
313415
// Stop bit
314416
this->write_bit_(true, &wait, start);
315417
if (this->stop_bits_ == 2)

‎esphome/components/uart/uart.h

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ namespace uart {
1010
#ifdef ARDUINO_ARCH_ESP8266
1111
class ESP8266SoftwareSerial {
1212
public:
13-
void setup(int8_t tx_pin, int8_t rx_pin, uint32_t baud_rate, uint8_t stop_bits);
13+
void setup(int8_t tx_pin, int8_t rx_pin, uint32_t baud_rate, uint8_t stop_bits, uint32_t nr_bits,
14+
std::string &parity);
1415

1516
uint8_t read_byte();
1617
uint8_t peek_byte();
@@ -34,6 +35,8 @@ class ESP8266SoftwareSerial {
3435
volatile size_t rx_in_pos_{0};
3536
size_t rx_out_pos_{0};
3637
uint8_t stop_bits_;
38+
uint8_t nr_bits_;
39+
std::string parity_;
3740
ISRInternalGPIOPin *tx_pin_{nullptr};
3841
ISRInternalGPIOPin *rx_pin_{nullptr};
3942
};
@@ -43,6 +46,8 @@ class UARTComponent : public Component, public Stream {
4346
public:
4447
void set_baud_rate(uint32_t baud_rate) { baud_rate_ = baud_rate; }
4548

49+
uint32_t get_config();
50+
4651
void setup() override;
4752

4853
void dump_config() override;
@@ -74,6 +79,8 @@ class UARTComponent : public Component, public Stream {
7479
void set_tx_pin(uint8_t tx_pin) { this->tx_pin_ = tx_pin; }
7580
void set_rx_pin(uint8_t rx_pin) { this->rx_pin_ = rx_pin; }
7681
void set_stop_bits(uint8_t stop_bits) { this->stop_bits_ = stop_bits; }
82+
void set_nr_bits(uint8_t nr_bits) { this->nr_bits_ = nr_bits; }
83+
void set_parity(const char *parity) { this->parity_ = std::string(parity); }
7784

7885
protected:
7986
void check_logger_conflict_();
@@ -88,6 +95,8 @@ class UARTComponent : public Component, public Stream {
8895
optional<uint8_t> rx_pin_;
8996
uint32_t baud_rate_;
9097
uint8_t stop_bits_;
98+
uint8_t nr_bits_;
99+
std::string parity_;
91100
};
92101

93102
#ifdef ARDUINO_ARCH_ESP32

0 commit comments

Comments
 (0)