Differences

This shows you the differences between two versions of the page.

Link to this comparison view

pmod:pmodtof:reference-manual [2021/05/14 23:03] – ↷ Page moved from reference:pmod:pmodtof:reference-manual to pmod:pmodtof:reference-manual Arthur Brownpmod:pmodtof:reference-manual [2023/02/08 20:34] (current) – external edit 127.0.0.1
Line 39: Line 39:
 ---- ----
 ===== Interfacing with the Pmod =====  ===== Interfacing with the Pmod ===== 
-The Pmod ToF communicates with the host board via the [[pmod:communication_protocols:I2C|I²C protocol]]. By first sending the 7-bit I²C address of 01010111 (0x57) and then a read/write bit (high/low logic level, respectively), followed by the register address of interest at a maximum clock frequency of 400 kHz, users can read and write Pmod ToF registers, thus implementing configuration of, calibration of, and reading of measurements from, the Pmod ToF. [[:reference:pmod:pmodtof:#J2 Pinout|Header J2]] on the Pmod ToF is a pass-through for all of the signals present on the main [[:reference:pmod:pmodtof:#J1 Pinout|Header J1]] to allow for the daisy chaining of multiple I²C compatible modules. +The Pmod ToF communicates with the host board via the [[pmod:communication_protocols:I2C|I²C protocol]]. By first sending the 7-bit I²C address of 01010111 (0x57) and then a read/write bit (high/low logic level, respectively), followed by the register address of interest at a maximum clock frequency of 400 kHz, users can read and write Pmod ToF registers, thus implementing configuration of, calibration of, and reading of measurements from, the Pmod ToF. [[pmod:pmodtof:#J2 Pinout|Header J2]] on the Pmod ToF is a pass-through for all of the signals present on the main [[pmod:pmodtof:#J1 Pinout|Header J1]] to allow for the daisy chaining of multiple I²C compatible modules. 
  
 ==== Application Register Map ==== ==== Application Register Map ====
  
  
-All the registers used in the measurement and/or calibration process are described in the ISL29501 [[https://www.renesas.com/eu/en/www/doc/datasheet/isl29501.pdf|ISL29501 datasheet]]. +All the registers used in the measurement and/or calibration process are described in the [[https://www.renesas.com/eu/en/www/doc/datasheet/isl29501.pdf|ISL29501 datasheet]]. 
  
-There is a set of registers used at every chip initialization. The Chip Initialization routine is described in [[https://www.renesas.com/us/en/www/doc/application-note/an1724.pdf?_ga=2.225173722.1727551698.1569238908-634851053.1552119990|ISL29501 Firmware Routines (an1724.pdf) documentation]].\\ +There is a set of registers used at every chip initialization. /* The Chip Initialization routine is described in [[https://www.renesas.com/us/en/www/doc/application-note/an1724.pdf?_ga=2.225173722.1727551698.1569238908-634851053.1552119990|ISL29501 Firmware Routines (an1724.pdf) documentation]]. */
-These values (see table below) are set by Digilent and the user must be very careful changing them. In this situation the user must modify these values before performing manual calibration.\\ +
-Please read [[https://www.renesas.com/in/en/www/doc/datasheet/isl29501.pdf?_ga=2.219327705.1727551698.1569238908-634851053.1552119990|ISL29501]] documentation before proceeding.\\+
  
-For more information, consult the [[reference:pmod:pmodtof:zynqlibraryuserguide#isl29501_-_time_of_flight_tof_integrated_circuit|Pmod ToF Library user guide]].\\+These values (see table below) are set by Digilent and the user must be very careful changing them. In this situation the user must modify these values before performing manual calibration. 
 + 
 +Please read [[https://www.renesas.com/us/en/document/dst/isl29501-datasheet?language=en|ISL29501]] documentation before proceeding.\\ 
 + 
 +For more information, consult the [[pmod:pmodtof:zynqlibraryuserguide#isl29501_-_time_of_flight_tof_integrated_circuit|Pmod ToF Library user guide]].\\
  
 NOTE: Prior to restoring the factory calibration, if the user modified these register values, they must be restored to the values specified below, otherwise the measurements won't be correct.\\ NOTE: Prior to restoring the factory calibration, if the user modified these register values, they must be restored to the values specified below, otherwise the measurements won't be correct.\\
Line 146: Line 148:
 The pins on the pin header are spaced 100 mil apart. The PCB is 1.6 inches long on the sides parallel to the pins on the pin header and 0.8 inches long on the sides perpendicular to the pin header. The pins on the pin header are spaced 100 mil apart. The PCB is 1.6 inches long on the sides parallel to the pins on the pin header and 0.8 inches long on the sides perpendicular to the pin header.
  
-====== Software Libraries======+===== Software Libraries=====
  
 Digilent provides a Library to access Pmod ToF functionality with Digilent FPGA development boards. The Library can be found in the [[https://github.com/Digilent/vivado-hierarchies|Vivado Hierarchies]] GitHub repository. Digilent provides a Library to access Pmod ToF functionality with Digilent FPGA development boards. The Library can be found in the [[https://github.com/Digilent/vivado-hierarchies|Vivado Hierarchies]] GitHub repository.
  
-A demo that allows communication with the Pmod ToF through UART is available in this [[https://github.com/Digilent/ZyboZ7-20-PmodToF-Demo|GitHub Repository]]. Functions such as calibration and measure can be accessed by issuing commands to the demo via a serial terminal application. Check the [[reference:pmod:pmodtof:zynqlibraryuserguide|Zybo Z7-20 Pmod ToF Demo User Guide]] for more details.+A demo that allows communication with the Pmod ToF through UART is available in this [[https://github.com/Digilent/ZyboZ7-20-PmodToF-Demo|GitHub Repository]]. Functions such as calibration and measure can be accessed by issuing commands to the demo via a serial terminal application. Check the [[pmod:pmodtof:zynqlibraryuserguide|Zybo Z7-20 Pmod ToF Demo User Guide]] for more details.
  
    
Line 158: Line 160:
  
  
-====== Additional Information ====== +===== Additional Information ===== 
-The schematics of the %%Pmod ToF%% are available {{:reference:pmod:pmodtof:pmodtof_sch.pdf |here}}. Additional information about the Intersil distance sensor, including communication modes and specific timings of the chip can be found in the "Documentation" area of the ISL29501 product page, found [[https://www.renesas.com/eu/en/products/sensors/proximity-sensors/light-to-digital-sensors/device/ISL29501.html#documents|here]].+The schematics of the %%Pmod ToF%% are available {{:reference:pmod:pmodtof:pmodtof_sch.pdf |here}}. Additional information about the Intersil distance sensor, including communication modes and specific timings of the chip can be found in the "Documentation" area of the ISL29501 product page, found [[https://www.renesas.com/eu/en/products/sensor-products/light-proximity-sensors/proximity-sensors/isl29501-time-flight-tof-signal-processing-ic#document|here]].
  
-Example code and more information on how to use the Pmod ToF can be found on its [[reference:pmod:pmodtof:start|Resource Center]].  +Example code and more information on how to use the Pmod ToF can be found on its [[pmod:pmodtof:start|Resource Center]].  
  
-If you have any questions or comments about the %%Pmod ToF%%, feel free to post them under the Add-on Boards section of the [[https://forum.digilentinc.com/forum/7-add-on-boards/|Digilent Forum]].+If you have any questions or comments about the %%Pmod ToF%%, feel free to post them under the Add-on Boards section of the [[https://forum.digilent.com/forum/7-add-on-boards/|Digilent Forum]].
  
 {{tag>pmod pmodtof distance reference-manual doc }} {{tag>pmod pmodtof distance reference-manual doc }}