arduino / arduino/ArduinoCore-API
Wire.requestFrom with 5 params is undocumented & exists only on AVR & SAM, not SAMD & megaAVR
- Vorherrschende Sprache
- C++
- Sterne
- 306
- Forks
- 150
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
Looks like a requestFrom() function taking 5 parameters is undocumented, and only implemented in 2 of the 4 platforms Arduino supports.
Here are the definitions in the AVR and SAM platforms:
https://github.com/arduino/ArduinoCore-avr/blob/master/libraries/Wire/src/Wire.h#L63
https://github.com/arduino/ArduinoCore-sam/blob/master/libraries/Wire/src/Wire.h#L49
However, the SAMD and megaAVR plaforms only have the 2 and 3 parameter requestFrom() functions in their Wire libs:
https://github.com/arduino/ArduinoCore-samd/blob/master/libraries/Wire/Wire.h#L45
https://github.com/arduino/ArduinoCore-megaavr/blob/master/libraries/Wire/src/Wire.h#L60
The Wire library requestFrom() reference page also only documents the 2 and 3 parameter functions:
https://www.arduino.cc/en/Reference/WireRequestFrom
This 5 parameter function should be properly documented, and should be consistently implemented on all platforms. Perhaps issues need to be opened on the repositories for the SAMD and megaAVR platforms?
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Rechercherichtung
Vergleiche die requestFrom()-Deklarationen in den verlinkten Wire.h-Dateien für die AVR-, SAM-, SAMD- und megaAVR-Cores und prüfe anschließend die Wire requestFrom-Referenzseite. Ermittle den vorgesehenen Umfang der API mit fünf Parametern über die Plattformen hinweg; abgeschlossen ist die Aufgabe, wenn das unterstützte Verhalten konsistent implementiert ist und die Referenzdokumentation es abdeckt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- cpp
- Bereich
- api, embedded-iot
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100