Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
pmod:pmodcmps:reference-manual [2021/10/13 20:57] – external edit 127.0.0.1pmod:pmodcmps:reference-manual [2022/10/04 11:38] (current) – external edit 127.0.0.1
Line 1: Line 1:
 +====== Pmod CMPS Reference Manual ======
  
 +<WRAP round info 650px>
 +===Note===
 +The Pmod CMPS has been replaced by the [[https://digilent.com/shop/pmod-cmps2-3-axis-compass/ | Pmod CMPS2]]. 
 +</WRAP>
 +
 +
 +The Digilent Pmod CMPS (Revision A) features the popular [[http://www51.honeywell.com/aero/common/documents/myaerospacecatalog-documents/Defense_Brochures-documents/HMC5883L_3-Axis_Digital_Compass_IC.pdf|Honeywell HMC5883L]] 3-axis digital compass and can add compass heading readings to any Digilent host board with an I²C interface. 
 +
 +{{Digilent Image Gallery 
 +| image = {{:reference:pmod:pmodcmps:pmodcmps-0.png?direct |}}
 +| image = {{:reference:pmod:pmodcmps:pmodcmps-1.png?direct |}}
 +| image = {{:reference:pmod:pmodcmps:pmodcmps-2.png?direct |}}
 +| image = {{:reference:pmod:pmodcmps:pmodcmps-3.png?direct |}}
 +}} 
 +
 +== Download This Reference Manual == 
 +  * {{:reference:pmod:pmodcmps:pmodcmps_rm.pdf| PDF}}
 +
 +----
 +
 +===== Features =====
 +  * 3-axis digital compass
 +  * 2 milli-gauss Field Resolution in ±8 gauss fields 
 +  * 160 %%Hz%% maximum data output rate 
 +  * Optional pull-up resistors for SCL and SDA pins
 +  * 2×4-pin connector with I2C interface
 +
 +----
 +=====Functional Description =====
 +The %%Pmod CMPS%% utilizes Honeywell's [[http://www51.honeywell.com/aero/common/documents/myaerospacecatalog-documents/Defense_Brochures-documents/HMC5883L_3-Axis_Digital_Compass_IC.pdf|HMC5883L]] with Anisotropic Magnetoresistive (AMR) technology. In plain English, this means that the three sensors (one for each coordinate direction) have very little interference with each other so that accurate data can be retrieved from the Pmod.
 +
 +----
 +===== Interfacing with the Pmod=====
 +The %%Pmod CMPS%% communicates with the host board via the [[pmod:communication_protocols:i2c|I²C protocol]]. Jumpers JP1 and JP2 provide optional 2.2kΩ pull-up resistors to use for the Serial Data and Serial Clock lines. The 7-bit address for this on-board chip is 0x1E, making the 8-bit address for a read command 0x3D and 0x3C for a write command.
 +
 +By default, the %%Pmod CMPS%% starts out in Single Measurement mode so that the compass takes a single measurement, sets the Data Ready pin high, and then places itself into Idle Mode. While in Idle Mode, major sources of power consumption are (not surprisingly) disabled, such as the internal ADC which collects the voltage measurements. However, you can still access all of the registers with their most recent data value through the I²C bus. To change the Pmod CMPS from idle mode back into Single Measurement or Continuous Measurement mode, the user must write to the Mode Register (0x02). 
 +
 +When reading data from the %%Pmod CMPS%%, all six data registers, corresponding to the upper and lower bytes of each Cartesian coordinate direction, must be read. Since the internal register address pointer automatically increments after a register has been successfully read, it is possible to read from all six registers with a single command. An example how this might look is given below:
 +
 +^  Command byte  ||||||||^  Address byte  |||||||||
 +|0|0|1|1|1|1|0|1|(ACK)|0|0|0|0|0|0|1|1|(ACK)|
 +^  MSB X  ||||||||^  LSB X  |||||||||
 +|SX|SX|SX|SX|sb|MSB|b9|b8|(ACK)|b7|b6|b5|b4|b3|b2|b1|b0|(ACK)|
 +^  MSB Z  ||||||||^  LSB Z  |||||||||
 +|SX|SX|SX|SX|sb|MSB|b9|b8|(ACK)|b7|b6|b5|b4|b3|b2|b1|b0|(ACK)|
 +^  MSB Y  ||||||||^  LSB Y  |||||||||
 +|SX|SX|SX|SX|sb|MSB|b9|b8|(ACK)|b7|b6|b5|b4|b3|b2|b1|b0|(STOP)|
 +
 +** Note* **  SX stands for a sign extension of the sign bit (sb)
 +
 +==== Pinout Description Table ====
 +^  Header J1                             |||   ^  Header J2  |||
 +^  Pins  ^  Signal  ^  Description          ^:::^  Pin  ^  Signal  ^  Description             ^
 +|  1 & 5   |  SCL     |  Serial Clock         |:::|  1    |  DRDY    |  Data Ready              |
 +|  2 & 6   |  SDA     |  Serial Data          |:::|  2    |  GND     |  Power Supply Ground     |
 +|  3 & 7   |  GND     |  Power Supply Ground  |:::^  Jumper JP1         |||
 +|  4 & 8   |  VCC     |  Power Supply (3.3V)  |:::|  Loaded State  ||  SDA line uses a 2.2kΩ pull-up resistor  |
 +|       |          |                       |:::^  Jumper JP2         |||
 +|  :::  |   :::    |          :::          |:::|  Loaded State  ||  SCL line uses a 2.2kΩ pull-up resistor  |
 +
 +**Table 1** Connector J1- Pin Descriptions as labeled on the Pmod
 +
 +The %%Pmod CMPS%% also offers a self test mode to help calibrate any data that is being received from the module.
 +
 +Any external power applied to the %%Pmod CMPS%% must be within 2.16V and 3.6V; therefore, when using Pmod headers on Digilent system boards, the supply voltage must be at 3.3V.
 +----
 +===== Physical Dimensions =====
 +The pins on the pin header are spaced 100 mil apart. The PCB is 0.8 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.
 +----
 +===== Additional Information =====
 +The schematics of the %%Pmod CMPS%% are available {{reference:pmod:pmodcmps:pmodcmps_sch.pdf|here}}. Additional information about the on-board IC can be found from Honeywell's website [[http://www51.honeywell.com/aero/common/documents/myaerospacecatalog-documents/Defense_Brochures-documents/HMC5883L_3-Axis_Digital_Compass_IC.pdf|here]].
 +
 +Example code demonstrating how to get information from the %%Pmod CMPS%% can be found [[pmod:pmodcmps:start#example_projects|here]]. 
 +
 +If you have any questions or comments about the %%Pmod CMPS%%, feel free to post them under the appropriate section ("Add-on Boards") of the [[https://forum.digilentinc.com/|Digilent Forum]].