arduino / arduino/ArduinoCore-API

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

Abierto
#92 2 comentarios 2 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
C++
Estrellas
306
Forks
150
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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?

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Línea de trabajo

Compara las declaraciones de requestFrom() en los archivos Wire.h enlazados para los cores AVR, SAM, SAMD y megaAVR, y después revisa la página de referencia de Wire requestFrom. Determina el alcance previsto de la API de cinco parámetros en las distintas plataformas; la tarea estará terminada cuando el comportamiento compatible esté implementado de forma coherente y la documentación de referencia lo cubra.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
cpp
Área
api, embedded-iot
Tipo de issue
Nueva funcionalidad
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.