-
Notifications
You must be signed in to change notification settings - Fork 2
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.
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
Add peripheral compatibility list #44
base: shared-docs
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks pretty good!
(I didn't render the texts though.)
peripheral_compat_list.inc
Outdated
|
||
|
||
|
||
RFID Reader |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
plural "Readers"
peripheral_compat_list.inc
Outdated
| Klefr 693x/694x | EIA-485 | Modbus | `EVerest`_ | `GenericPowermeter`_ | ✓ | | ||
+---------------------+-----------+----------+-------------+------------------------+----------------------+ | ||
| Iskra WM3M4/WM3M4C | EIA-485 | Modbus | chargebyte | PowermeterIskra_WM3M4C | ✓ | | ||
+---------------------+-----------+----------+-------------+------------------------+----------------------+ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It might be interesting to point out that none of these support Eichrecht (yet).
There does exist a Rust module for Iskra with Eichrecht support, but we don't deliver it currently.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point, I will add a new column for this. I did not mentioned the Rust module on purpose for the mentioned reason.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just some notes
peripheral_compat_list.inc
Outdated
-- | ||
|
||
+---------------------+-----------+----------+-------------+------------------------+--------------------------+----------------------+ | ||
| Vendor / Product | Interface | Protocol | Implementer | EVerest Module Name | German Eichrecht Support | Tested by chargebyte | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
German Eichrecht Support apply to the EVerest implementation and not to the product capabilities? I'm not sure this is something we should maintain. I see the value, but as long we didn't see this working, i think we should be careful.
peripheral_compat_list.inc
Outdated
-- | ||
|
||
+---------------------+-----------+----------+-------------+------------------------+--------------------------+----------------------+ | ||
| Vendor / Product | Interface | Protocol | Implementer | EVerest Module Name | German Eichrecht Support | Tested by chargebyte | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we should provide a foot note to explain that not all meter values are/can be provided.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I add a note, not only a footnote, so it doesn't get missed.
+-----------------------------------------+-----------+-------------+-------------+--------------------------+----------------------+ | ||
|
||
.. _PN532TokenProvider: https://github.com/EVerest/everest-core/tree/main/modules/PN532TokenProvider | ||
.. _PN7160TokenProvider: https://github.com/EVerest/everest-core/tree/main/modules/PN7160TokenProvider |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we should add a paragraph like "If you need some specific component implemented, feel free to contact us."
|
||
|
||
RFID Readers | ||
============ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about the following chapters:
HMI interfaces (Buzzlight, GPIO LED)
Type 2 locking devices (additional list with reference to locking motor)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll add GPIO based modules, but since Buzzlight is vendor specific, I'd not mention it here.
For the plug lock compats, I'd only add a hint to look into platform specific documentation.
Signed-off-by: Michael Heimpold <[email protected]>
Signed-off-by: Michael Heimpold <[email protected]>
No description provided.