arduino / arduino/ArduinoCore-API

Wire.requestFrom with 5 params is undocumented & exists only on AVR & SAM, not SAMD & megaAVR

Aperta
#92 2 commenti 2 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
C++
Stelle
306
Fork
150
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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?

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Confronta le dichiarazioni di requestFrom() nei file Wire.h collegati per i core AVR, SAM, SAMD e megaAVR, quindi esamina la pagina di riferimento di Wire requestFrom. Determina l'ambito previsto dell'API a cinque parametri tra le piattaforme; il lavoro è completato quando il comportamento supportato è implementato in modo coerente e la documentazione di riferimento lo copre.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
cpp
Ambito
api, embedded-iot
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.