Skip to content

esp32,esp8266: Update espnow docs for WLAN.config(pm=x) option. #11455

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 19, 2023

Conversation

glenn20
Copy link
Contributor

@glenn20 glenn20 commented May 10, 2023

Updates for the espnow module documentation following merge of #8993.

Also includes a few updates and clarifications following merge of #6515.

Update docs/library/espnow.rst to add:

  • guidance on using WLAN.config(pm=WLAN.PM_NONE) for reliable espnow performance while also connected to a wifi access point.
  • correction on use of add_peer() for receiving encrypted messages
  • correction for default value of "encrypt" parameter (add_peer())
  • guidance on use of ESPNow.irq(): recommand users readout all messages in the buffer each time the callback is called.

@glenn20 glenn20 changed the title esp32,esp8266: Update espnow docs for WLAN.config(pm=x) options. esp32,esp8266: Update espnow docs for WLAN.config(pm=x) option. May 10, 2023
@glenn20 glenn20 force-pushed the espnow-docs-update branch from 0d28e1a to c1b281c Compare May 10, 2023 03:22
@dpgeorge dpgeorge added the docs label May 18, 2023
@glenn20 glenn20 force-pushed the espnow-docs-update branch 2 times, most recently from c1b281c to 9c05ee4 Compare May 19, 2023 06:27
@glenn20 glenn20 requested a review from dpgeorge May 19, 2023 06:28
@glenn20 glenn20 force-pushed the espnow-docs-update branch from 9c05ee4 to 694f30c Compare May 19, 2023 09:46
Update docs/library/espnow.rst to add:
- guidance on using WLAN.config(pm=WLAN.PM_NONE) for reliable
  espnow performance while also connected to a wifi access point;
- guidance on receiving encrypted messages;
- correction for default value of "encrypt" parameter (add_peer());
- guidance on use of ESPNow.irq(): recommand users readout all messages
  in the buffer each time the callback is called.

Signed-off-by: Glenn Moloney <glenn.moloney@gmail.com>
@dpgeorge dpgeorge force-pushed the espnow-docs-update branch from 694f30c to 12dbbc8 Compare May 19, 2023 11:49
@dpgeorge
Copy link
Member

Thanks for updating.

@dpgeorge dpgeorge merged commit 12dbbc8 into micropython:master May 19, 2023
@glenn20 glenn20 deleted the espnow-docs-update branch May 19, 2023 11:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants