basic support for nrf52840 #6075

tomaszduda23 · 2024-01-10T23:17:32Z

What does this implement/fix?

It is possible to buy cheap nrf52840 module. It would be very convenience to program it using yaml files.
It is proof of concept for support NRF52 on esphome.

How to upload

There are few options:

with stlink python -m esphome upload tests/test12.2.yaml --device PYOCD
if board have adafruit bootloader image has to build with

nrf52:
  board: adafruit_itsybitsy_nrf52840

to upload python -m esphome upload tests/test12.3.yaml

if board support UF2

cp ./tests/.esphome/build/nrf52-test-nrf-adafruit/.pioenvs/nrf52-test-nrf-adafruit/zephyr/zephyr.uf2 /media/0321-5432/

BLE OTA with mcuboot python -m esphome upload tests/test12.2.yaml to specify mac address of BLE device python -m esphome upload tests/test12.2.yaml --device AA:BB:CC:11:22:33

TODO

Arduino
moved to #6228

Zephyr

Fix review comments #6075 (comment)

fix build with python 3.9
support for python 3.9 intercreate/smpclient#16
move tests to new structure in tests/components/
check Separate OTABackend from OTA component #6459
move small changes unrelated components to own PRs
fix conflict with EMPTY macro in zephyr #6679
wrapped code with #ifdef USE_ZEPHYR or #ifdef USE_NRF52

How to communicate with HA? Options:

BLE serial
10KB/s - 2M PHY, interval of 7.5 ms, 247MTU
BTHome
Bluetooth only device with BTHome format feature-requests#1862
sensors only
custom BLE service
https://novelbits.io/bluetooth-5-speed-maximum-throughput/
openthread https://openthread.io/codelabs/openthread-hardware#1
zigbee Zigbee tomaszduda23/esphome#2

The SoC has only 1MB of memory. All above consume:

RAM:   [=         ]   5.9% (used 14736 bytes from 248832 bytes)
Flash: [==        ]  17.9% (used 146000 bytes from 815104 bytes)

update adafruit bootloader

git clone https://github.com/adafruit/Adafruit_nRF52_Bootloader
cd Adafruit_nRF52_Bootloader
make BOARD=nice_nano all
make BOARD=nice_nano SERIAL=/dev/ttyACM0 flash-dfu

Types of changes

Bugfix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Other

Related issue or feature (if applicable): fixes

Pull request in esphome-docs with documentation (if applicable): esphome/esphome-docs#

Test Environment

Example entry for `config.yaml`:

---
nrf52:
  # board: adafruit_itsybitsy_nrf52840
  board: adafruit_feather_nrf52840
  # framework:
  # variant: nrf-sdk
  # bootloader: adafruit
  # bootloader: mcuboot

esphome:
  name: nrf52-test-nrf

logger:
  level: DEBUG
  logs:
    switch: NONE

switch:
  - platform: gpio
    pin:
      number: 15
      inverted: true
      mode:
        output: true
    id: gpio_15

interval:
  - interval: 500ms
    then:
      - switch.toggle: gpio_15

output:
  - platform: gpio
    pin:
      number: 14
      inverted: true
      mode:
        output: true
    id: rest_gpio

ota:
  - platform: zephyr_mcumgr

zephyr_ble_server:

Checklist:

The code change is tested and works locally.
Tests have been added to verify that the new code works (under tests/ folder).

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in esphome-docs.

probot-esphome · 2024-01-10T23:17:42Z

Hey there @esphome/core, mind taking a look at this pull request as it has been labeled with an integration (logger) you are listed as a code owner for? Thanks!
_{^{(message by CodeOwnersMention)}}

probot-esphome · 2024-01-10T23:17:46Z

Hey there @tomaszduda23,
Thanks for submitting this pull request! Can you add yourself as a codeowner for this integration? This way we can notify you if a bug report for this integration is reported.
In __init__.py of the integration, please add:

CODEOWNERS = ["@tomaszduda23"]

And run script/build_codeowners.py

_{^{(message by NeedsCodeownersLabel)}}

codecov-commenter · 2024-01-10T23:18:56Z

Codecov Report

Attention: Patch coverage is 20.57416% with 166 lines in your changes missing coverage. Please review.

Project coverage is 53.79%. Comparing base (4d8b5ed) to head (c2698a5).
Report is 727 commits behind head on dev.

Files	Patch %	Lines
esphome/zephyr_tools.py	22.05%	106 Missing ⚠️
esphome/__main__.py	5.45%	52 Missing ⚠️
esphome/writer.py	0.00%	3 Missing ⚠️
esphome/config_validation.py	60.00%	2 Missing ⚠️
esphome/core/config.py	33.33%	1 Missing and 1 partial ⚠️
esphome/core/__init__.py	83.33%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##              dev    #6075      +/-   ##
==========================================
+ Coverage   53.70%   53.79%   +0.08%     
==========================================
  Files          50       51       +1     
  Lines        9408     9824     +416     
  Branches     1654     1737      +83     
==========================================
+ Hits         5053     5285     +232     
- Misses       4056     4213     +157     
- Partials      299      326      +27

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

probot-esphome · 2024-01-11T12:32:18Z

Hey there @esphome/core, mind taking a look at this pull request as it has been labeled with an integration (adc) you are listed as a code owner for? Thanks!
_{^{(message by CodeOwnersMention)}}

lboue · 2024-01-11T21:21:34Z

I am very interested in testing this platform in ESPHome because I own several nrf52840 modules.

probot-esphome · 2024-01-12T08:34:01Z

Hey there @OttoWinter, mind taking a look at this pull request as it has been labeled with an integration (api) you are listed as a code owner for? Thanks!
_{^{(message by CodeOwnersMention)}}

probot-esphome · 2024-01-12T08:34:04Z

Hey there @OttoWinter, mind taking a look at this pull request as it has been labeled with an integration (debug) you are listed as a code owner for? Thanks!
_{^{(message by CodeOwnersMention)}}

probot-esphome · 2024-01-12T08:34:04Z

Hey there @esphome/core, mind taking a look at this pull request as it has been labeled with an integration (network) you are listed as a code owner for? Thanks!
_{^{(message by CodeOwnersMention)}}

Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>

probot-esphome · 2024-05-20T21:57:23Z

Hey there @esphome/core, mind taking a look at this pull request as it has been labeled with an integration (adc) you are listed as a code owner for? Thanks!
Hey there @OttoWinter, mind taking a look at this pull request as it has been labeled with an integration (debug) you are listed as a code owner for? Thanks!
_{^{(message by CodeOwnersMention)}}

probot-esphome · 2024-05-20T21:57:27Z

Hey there @esphome/core, mind taking a look at this pull request as it has been labeled with an integration (i2c) you are listed as a code owner for? Thanks!
Hey there @esphome/core, mind taking a look at this pull request as it has been labeled with an integration (logger) you are listed as a code owner for? Thanks!
Hey there @esphome/core, mind taking a look at this pull request as it has been labeled with an integration (ota) you are listed as a code owner for? Thanks!
_{^{(message by CodeOwnersMention)}}

Hedda · 2024-05-21T08:19:43Z

@tomaszduda23 FYI, just stumbled on a forum thread by @natelust about his ESPHome to Zephyr RTOS porting project and was wondering if you were aware of his previous work on getting ESPHome running on a nRF5 platform for nRF52 and nRF53?

https://community.home-assistant.io/t/announcement-esphome-running-on-adafruit-52840-over-thread-mesh-networking-using-zephyrrtos/363712

Looks like he has not updated his forked esphome repository with his code patch to add Zephyr platform support patches in the last year as it seems like his "zephyr-dev" branch there in his esphome fork contains his latest updates:

https://github.com/natelust/esphome/tree/zephyr-dev

There do not seem to be any new posts from him on this since he posted this zephyr ESPHome Guide in little over 1-year ago:

https://github.com/natelust/zephyrESPHomeGuide

PS: Noted that he also looks to have made more progress on OpenThread/Thread support in ESPHome than anyone else I have seen posting in public repository so far?

esphome/feature-requests#1397

tomaszduda23 · 2024-05-21T09:15:34Z

I've seen that fork some time ago.
OpenThread was the reason to move from generic zephyr to nrf-sdk. It can be done. I haven't had time to look into details though.

natelust · 2024-05-30T13:12:06Z

Hi all, sorry your message before caught me in the middle of a lot of stuff going on, and I am sitting down now trying to work through all I need to catch up on. What can I help out with? I had personally chosen to go with core zephyr over the nrf sdk, but things might have changed since then. I had everything up and running stable for some time and did not have much more time to put into it (also getting in upstreamed was stalled a bit). However, recently I had to redo my whole setup, and was going to revive the work, especially now that home assistant has been modified with ipv6 native to work with matter. The way I had things set up (I have not looked at this work yet) it was nice because it was relatively easy to support all the boards that zephyr supported.

tomaszduda23 · 2024-05-30T19:43:25Z

@natelust it supported both nrf-sdk and generic zephyr. I dropped generic zephyr to avoid extra testing. It could be added back though.
Merge any NRF52 framework to upstream would be great. If you would like to help with things here I'm down. Openthread would be interesting.
For me BLE is thing which I want to complete first since it is needed for my project. Recently I looked to zigbee. It is quite a lot of work to support different sensor though.

Hedda · 2024-05-31T06:35:55Z

it supported both nrf-sdk and generic zephyr. I dropped generic zephyr to avoid extra testing.

I am assuming it would be much less complex to only try to get one of those platforms merged at first, however, probably worth considering adding both platforms sooner or later as more similar platforms can gain long-term benefits as it would kind of be following "chaos engineering" principle as experimenting with similar platform could help identify potential issues or problems? ;)

tomaszduda23 · 2024-05-31T07:09:51Z

Nrf sdk is based on zephyr. It contains extra stuff for nrf chips. The build system and most of drivers are the same. A lot of things will just work for both.

natelust · 2024-05-31T16:45:28Z

I was looking at some of the changes to home assistant last night now that matter/thread support is "built in". I think this greatly lowers the barrier to what I have implemented being used. The ESPHome boards should be able to run right over the same thread network and border router, and mostly be transparent to end users.

I'm trying to figure out what would be the most helpful thing for me right now. How does me getting my fork updated against the main, and then coming back and having a discussion on how this work dovetails with what I have done sound? I had not put any effort into the bluetooth stack before, so it might be nice if the solutions can come together.

Hedda · 2024-06-01T12:31:04Z

I'm trying to figure out what would be the most helpful thing for me right now. How does me getting my fork updated against the main, and then coming back and having a discussion on how this work dovetails with what I have done sound? I had not put any effort into the bluetooth stack before, so it might be nice if the solutions can come together.

I have not seen or heard of else started work on OpenThread support for ESPHome, so you might want to consider that if you want to work on something that no one else is working on. If so please also make Thread protocol support compatible with ESP32-H2 and ESP32-C6 SoCs too.

tomaszduda23 · 2024-06-05T19:15:01Z

PoC of zigbee tomaszduda23#2

tomaszduda23 requested a review from a team as a code owner January 10, 2024 23:17

probot-esphome bot added core has-tests integration: logger new-integration integration: beacon integration: dfu integration: nrf52 needs-docs labels Jan 10, 2024

probot-esphome bot added the needs-codeowners label Jan 10, 2024

probot-esphome bot added the integration: adc label Jan 11, 2024

tomaszduda23 requested a review from OttoWinter as a code owner January 12, 2024 08:33

probot-esphome bot added integration: api integration: debug integration: network needs-tests and removed has-tests labels Jan 12, 2024

probot-esphome bot assigned OttoWinter Jan 12, 2024

tomaszduda23 force-pushed the nrf52 branch from c7b70f3 to d520c2f Compare January 12, 2024 08:35

probot-esphome bot added has-tests and removed needs-tests integration: api labels Jan 12, 2024

tomaszduda23 and others added 6 commits May 19, 2024 10:32

Update esphome/components/deep_sleep/deep_sleep_component.cpp

d271566

Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>

Merge remote-tracking branch 'origin/dev' into deep_sleep

1571666

Merge branch 'deep_sleep' into nrf52

c4f0510

Merge remote-tracking branch 'origin/dev' into nrf52

1e93c5b

change tab to space

60d31a0

add i2c

04bf125

probot-esphome bot added the integration: i2c label May 20, 2024

Merge remote-tracking branch 'origin/dev' into nrf52

738b167

tomaszduda23 marked this pull request as ready for review May 20, 2024 21:57

probot-esphome bot assigned OttoWinter May 20, 2024

tomaszduda23 added 6 commits May 22, 2024 00:16

let user select uart for serial ota

61a25cf

use official smpclient

00c70b1

Merge remote-tracking branch 'origin/dev' into nrf52

26c15df

add upload timeout

875e083

update smpclient to 3.2.0

9091b4f

Merge remote-tracking branch 'origin/dev' into nrf52

65f65c1

Merge branch 'dev' into nrf52

cff3337

tomaszduda23 added 2 commits June 5, 2024 21:16

Merge branch 'dev' into nrf52

678c325

Merge branch 'dev' into nrf52

c2698a5

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

basic support for nrf52840 #6075

basic support for nrf52840 #6075

tomaszduda23 commented Jan 10, 2024 •

edited

probot-esphome bot commented Jan 10, 2024

probot-esphome bot commented Jan 10, 2024

codecov-commenter commented Jan 10, 2024 •

edited

probot-esphome bot commented Jan 11, 2024

lboue commented Jan 11, 2024

probot-esphome bot commented Jan 12, 2024

probot-esphome bot commented Jan 12, 2024

probot-esphome bot commented Jan 12, 2024

probot-esphome bot commented May 20, 2024

probot-esphome bot commented May 20, 2024

Hedda commented May 21, 2024 •

edited

tomaszduda23 commented May 21, 2024

natelust commented May 30, 2024 •

edited

tomaszduda23 commented May 30, 2024

Hedda commented May 31, 2024 •

edited

tomaszduda23 commented May 31, 2024 •

edited

natelust commented May 31, 2024

Hedda commented Jun 1, 2024 •

edited

tomaszduda23 commented Jun 5, 2024

basic support for nrf52840 #6075

Are you sure you want to change the base?

basic support for nrf52840 #6075

Conversation

tomaszduda23 commented Jan 10, 2024 • edited

What does this implement/fix?

How to upload

TODO

update adafruit bootloader

Types of changes

Test Environment

Example entry for config.yaml:

Checklist:

probot-esphome bot commented Jan 10, 2024

probot-esphome bot commented Jan 10, 2024

codecov-commenter commented Jan 10, 2024 • edited

Codecov Report

probot-esphome bot commented Jan 11, 2024

lboue commented Jan 11, 2024

probot-esphome bot commented Jan 12, 2024

probot-esphome bot commented Jan 12, 2024

probot-esphome bot commented Jan 12, 2024

probot-esphome bot commented May 20, 2024

probot-esphome bot commented May 20, 2024

Hedda commented May 21, 2024 • edited

tomaszduda23 commented May 21, 2024

natelust commented May 30, 2024 • edited

tomaszduda23 commented May 30, 2024

Hedda commented May 31, 2024 • edited

tomaszduda23 commented May 31, 2024 • edited

natelust commented May 31, 2024

Hedda commented Jun 1, 2024 • edited

tomaszduda23 commented Jun 5, 2024

tomaszduda23 commented Jan 10, 2024 •

edited

Example entry for `config.yaml`:

codecov-commenter commented Jan 10, 2024 •

edited

Hedda commented May 21, 2024 •

edited

natelust commented May 30, 2024 •

edited

Hedda commented May 31, 2024 •

edited

tomaszduda23 commented May 31, 2024 •

edited

Hedda commented Jun 1, 2024 •

edited