Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update Arduino as ESP-IDF documentation: How to use USBHID classes with ESP32-S2 and ESP32-S3 #7214

Merged
merged 4 commits into from
Nov 16, 2022
Merged

Update Arduino as ESP-IDF documentation: How to use USBHID classes with ESP32-S2 and ESP32-S3 #7214

merged 4 commits into from
Nov 16, 2022

Conversation

RefactorFactory
Copy link
Contributor

Description of Change

When using Arduino as an ESP-IDF component, one needs to do special setup if you want to use arduino-esp32 USBHID classes. This explains how.

These instructions are based on esp32-arduino-lib-builder's build process, including https://github.com/espressif/esp32-arduino-lib-builder/blob/master/tools/update-components.sh which explains how to clone tinyusb.

Tests scenarios

I have tested my Pull Request on ESP-IDF v4.4.1 and Arduino-esp32 core v2.0.4 with ESP32-S2 Board with this scenario.

@RefactorFactory
How to use USBHID classes with ESP32-S2 and ESP32-S3
17db143 
These instructions are based on esp32-arduino-lib-builder's build process, including https://github.com/espressif/esp32-arduino-lib-builder/blob/master/tools/update-components.sh which explains how to clone tinyusb.
@VojtechBartoska VojtechBartoska added the Type: Documentation Issue pertains to Documentation of Arduino ESP32 label Sep 5, 2022
@VojtechBartoska
Copy link
Collaborator

Thanks for the PR @RefactorFactory.

@P-R-O-C-H-Y Can you please help with the review as you contributed to this part of Documentation in the past? Thanks

@VojtechBartoska VojtechBartoska merged commit bf53e2b into espressif:master Nov 16, 2022
@RefactorFactory RefactorFactory deleted the patch-1 branch November 17, 2022 21:56
vortigont pushed a commit to vortigont/arduino-esp32 that referenced this pull request Dec 11, 2022
@RefactorFactory @vortigont
How to use USBHID classes with ESP32-S2 and ESP32-S3 (espressif#7214)
619dd88 
These instructions are based on esp32-arduino-lib-builder's build process, including https://github.com/espressif/esp32-arduino-lib-builder/blob/master/tools/update-components.sh which explains how to clone tinyusb.
Jason2866 added a commit to tasmota/arduino-esp32 that referenced this pull request Dec 17, 2022
@Jason2866 @P-R-O-C-H-Y
@sanketwadekar @RefactorFactory @sebastianbergner @SuGlider @sgryphon @nuclearcat @s-hadinger
Tasmota with IPv6 (#172)
77b46de 
* LEDC - AnalogWrite new API + ledcAttachPin duty fix (espressif#7346)

* Add enableScenes API in Rainmaker (espressif#7436)

* Added enableScenes API

* Added enableScenes API documentation

* Added enableScenes API to example

Co-authored-by: Jan Procházka <90197375+P-R-O-C-H-Y@users.noreply.github.com>

* How to use USBHID classes with ESP32-S2 and ESP32-S3 (espressif#7214)

These instructions are based on esp32-arduino-lib-builder's build process, including https://github.com/espressif/esp32-arduino-lib-builder/blob/master/tools/update-components.sh which explains how to clone tinyusb.

* Add I2C and SPI pin definitions to wt32-eth01 pins configuration (espressif#7237)

* Add I2C and SPI pin definitions to wt32-eth01 pins

Added missing pins based on testing using a RTC (I2C) and SD card reader (SPI).

* Remove define macros

Co-authored-by: Rodrigo Garcia <rodrigo.garcia@espressif.com>
Co-authored-by: Jan Procházka <90197375+P-R-O-C-H-Y@users.noreply.github.com>

* Changed Rainmaker WiFi/Factory reset time. (espressif#7514)

* Ipv6 support v2

* Update header

* Update IPAddress implementation to support V6

* Fix cut and paste error

* Explicit not equals

* Explicitly reference StreamString

* Remove != test (it is causing a conflict)

* IPv6 support: Add proper link-local and SLAAC in STA and WifiMulti

This patch partially depends on:
espressif/esp32-arduino-lib-builder#67
Without this patch we will get only Link local IPv6 (still useful for MDNS and etc).
With patch we will get also global IPv6 address by SLAAC.
By default IPv6 disabled, until it is properly tested.

Tested on BasicHttpClient by adding:
wifiMulti.IPv6(true);
before: wifiMulti.addAP() call

Enabling Core Debug Level: verbose
If IP6 obtained, in logs will be visible:
[  8028][V][WiFiGeneric.cpp:380] _arduino_event_cb(): IF[0] Got IPv6: IP Index: 0, Zone: 2, fe80:0000:0000:0000:xxxx:xxxx:xxxx:xxxx
[  8028][D][WiFiGeneric.cpp:852] _eventCallback(): Arduino Event: 8 - STA_GOT_IP6
[ 11028][V][WiFiGeneric.cpp:380] _arduino_event_cb(): IF[0] Got IPv6: IP Index: 1, Zone: 0, 2a0d:yyyy:0000:4000:yyyy:yyyy:yyyy:yyyy
[ 11028][D][WiFiGeneric.cpp:852] _eventCallback(): Arduino Event: 8 - STA_GOT_IP6

This is linked to: espressif#6242

Signed-off-by: Denys Fedoryshchenko <denys.f@collabora.com>

* Add IPv6 support to WiFiServer

One of most useful features of IPv6 to have arduino accessible from internet,
without any port forward and etc.
Change is fairly trivial and backward compatible with old code, tested
with WiFiTelnetToSerial and AsyncUDPServer.

Signed-off-by: Denys Fedoryshchenko <denys.f@collabora.com>

* WiFiClient::remoteIP and remoteIP6 IPv6 support

For RemoteIP and AF_INET6 socket i added support ip6 to ip4 mapping,
so .remoteIP will return IPv4 address on dual stack socket, if available.

Scenarios tested:
WiFiTelnetToSerial, wifiMulti.IPv6(true), connect both from IPv4 and IPv6
WiFiTelnetToSerial, wifiMulti.IPv6(true); but set to listen on IPv4 only.
WiFiTelnetToSerial, IPv6 disabled, with or without bind to specific IP4.
AsyncUDPServer, without IPv6 support.

Signed-off-by: Denys Fedoryshchenko <denys.f@collabora.com>

* Add WiFiTelnetToSerialIPv6 example

To demonstrate new abilities of dual stack WiFiServer and
remoteIP6 we add this example.

Signed-off-by: Denys Fedoryshchenko <denys.f@collabora.com>

* Add IPv6 to WifiClient (client)

We need to be able to connect to remote servers over IPv6 too,
and thats need different approach in DNS queries and connect().
As i'm trying to keep maximum compatibility, i introduce different
behaviour if IPv6 is enabled, and backward compatible (as much as possible),
if IPv6 is not enabled.
IN future when IPv6 functions are tested well enough, it can be simplified.

This implementation tested on esp32 in following scenarios using BasicHttpClient:

IPv6 true:
IPv6 only website (caveat 1) - OK
Website with A and AAAA is present (caveat 1) - OK
IPv4 only website - OK

IPv6 not enabled:
IPv6 only website - wont open (expected)
Website with A and AAAA is present - OK, opens over IPv4
IPv4 only website - OK

caveat 1 - sometimes SLAAC is slower than DHCPv4, so we might have
status WL_CONNECTED, but IPv6 global scope is not ready yet.

Signed-off-by: Denys Fedoryshchenko <denys.f@collabora.com>

* WiFiTelnetToSerialIPv6.ino: fix obsolete remoteIP6 call to remoteIP

Example contained API from previous IPv6 implementation, fixing it.

Signed-off-by: Denys Fedoryshchenko <denys.f@collabora.com>

Signed-off-by: Denys Fedoryshchenko <denys.f@collabora.com>
Co-authored-by: Sly Gryphon <sgryphon@computer.org>
Co-authored-by: Denys Fedoryshchenko <denys.f@collabora.com>

* Fix toString() for IPv4

* Full support for IPv6

* Full support for IPv6

* Fixed ambiguous definitions

* Fix sizeof

* Simplify initilization and remove memset

* Enable support for IPv6 in UDP

* Update PlatformIO build script PR 7579

* Fix IPv6 size

Signed-off-by: Denys Fedoryshchenko <denys.f@collabora.com>
Co-authored-by: Jan Procházka <90197375+P-R-O-C-H-Y@users.noreply.github.com>
Co-authored-by: Sanket Wadekar <67091512+sanketwadekar@users.noreply.github.com>
Co-authored-by: RefactorFactory <108912458+RefactorFactory@users.noreply.github.com>
Co-authored-by: Sebastian Bergner <54766531+sebastianbergner@users.noreply.github.com>
Co-authored-by: Rodrigo Garcia <rodrigo.garcia@espressif.com>
Co-authored-by: Sly Gryphon <sgryphon@computer.org>
Co-authored-by: Denys Fedoryshchenko <denys.f@collabora.com>
Co-authored-by: s-hadinger <49731213+s-hadinger@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@me-no-dev me-no-dev me-no-dev approved these changes

@P-R-O-C-H-Y P-R-O-C-H-Y P-R-O-C-H-Y approved these changes

Assignees
No one assigned
Labels
Type: Documentation Issue pertains to Documentation of Arduino ESP32
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@RefactorFactory @VojtechBartoska @me-no-dev @P-R-O-C-H-Y