-
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
Diode test card OD #36
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.
I'd like to see more usage of the descriptive fields where applicable. These include:
unit
andscale_factor
. Prefer standard units like A or S and then usescale_factor
to scale them to the actual value you put in the subindex. For example if you reportled_current
in uA, then setuint
to A andscale_factor
to 0.000001.high_limit
andlow_limit
. Only if the limits are readily available, otherwise the whole range is valid.value_descriptions
. For enum-like things. Probablyctrl
?bit_definitions
. For bitfield like things. Probablyerror
andstatus
?default
. Where a default value would make sense. Maybectrl
andmux_select
?
You can find some documentation here but there's also examples in other configs on how to use them.
Thanks Theo! I'll work on these changes. I think I am blocked on the units and scale_factor in the adcsample portion of the OD until I have more information from Anna and Andrew. That's why this is left as uint. This portion of the code is unfinished in app_diode as well as the bit fields in error and status. I also don't expect all the bits to be used at this time. Do you want me to put placeholders in for the unknowns? |
If it's unknown it's fine to leave the units off until they're determined. An alternative idea, since this is ADC output, is to mark the unit as
No need for placeholders, only mark the bits that you use. As more bits get used the configs can be updated. If none are currently used you could possibly add a comment saying "currently unused" or something to that effect. |
…ime to 10 seconds
These are the updates to the OD for the diode test card.