search

Xilinx / PYNQ

Python Productivity for ZYNQ
http://www.pynq.io/
BSD 3-Clause "New" or "Revised" License
1.98k stars 816 forks source link

Different versions of Grove peripherals #42

Closed cathalmccabe closed 8 years ago

cathalmccabe commented 8 years ago

There are different versions of Grove modules. We should include something in the header of the .py & .c driver files to indicated which peripheral we are targeting. Preferably version number and a reference to webpage/datasheet

e.g. Temperature sensor has V1,1.1,1.2. V1.1, and 1.2 can use the same code. V1 needs a different offset to calculate temperature.

e.g. We have code for a Grove IMU. It is unclear which one this is for as there is a 9DOF, 10DOF ( and different versions).

To future proof, We should probably do this for the Pmods too. Even though Digilent seem to be more consistent.

parimalp commented 8 years ago

It may be good to include the version number to the py and bin filename, as well as folder.

Parimal

From: cathalmccabe [mailto:notifications@github.com] Sent: Monday, April 25, 2016 3:58 AM To: Xilinx/Pynq Pynq@noreply.github.com Subject: [Xilinx/Pynq] Different versions of Grove peripherals (#42)

There are different versions of Grove modules. We should include something in the header of the .py & .c driver files to indicated which peripheral we are targeting. Preferably version number and a reference to webpage/datasheet

e.g. Temperature sensor has V1,1.1,1.2. V1.1, and 1.2 can use the same code. V1 needs a different offset to calculate temperature.

e.g. We have code for a Grove IMU. It is unclear which one this is for as there is a 9DOF, 10DOF ( and different versions).

To future proof, We should probably do this for the Pmods too. Even though Digilent seem to be more consistent.

— You are receiving this because you are subscribed to this thread. Reply to this email directly or view it on GitHubhttps://github.com/Xilinx/Pynq/issues/42

This email and any attachments are intended for the sole use of the named recipient(s) and contain(s) confidential information that may be proprietary, privileged or copyrighted under applicable law. If you are not the intended recipient, do not read, copy, or forward this email message or any attachments. Delete this email message and any attachments immediately.

schelleg commented 8 years ago

Let's add comment in python (that is acccessible from help(...) ) and big commenting in Microblaze C.

We'll close once code is commented.

yunqu commented 8 years ago

I have cleared up the SDK codes for grove devices and added license.

Let me know if there is any issue.

I will continue to work on pmod devices and clear up their codes tomorrow.

yunqu commented 8 years ago

Just added into python comment the version number. I will continue to update in the future if new modules are added.