arduino / arduino/ArduinoCore-API
Wire.requestFrom with 5 params is undocumented & exists only on AVR & SAM, not SAMD & megaAVR
- Ngôn ngữ chính
- C++
- Star
- 306
- Fork
- 150
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
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?
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Hướng nghiên cứu
So sánh các khai báo requestFrom() trong các tệp Wire.h được liên kết dành cho các core AVR, SAM, SAMD và megaAVR, sau đó xem lại trang tham chiếu Wire requestFrom. Xác định phạm vi API năm tham số được dự định trên các nền tảng; công việc được xem là hoàn tất khi hành vi được hỗ trợ được triển khai nhất quán và tài liệu tham chiếu bao quát hành vi đó.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- cpp
- Lĩnh vực
- api, embedded-iot
- Loại issue
- Tính năng
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100