Skip to content

Commit 188d849

Browse files
authored
Update README.adoc's for various examples to remove unnecessary block callouts. (#182)
1 parent f800a7e commit 188d849

File tree

5 files changed

+12
-19
lines changed

5 files changed

+12
-19
lines changed

i2c/lis3dh_i2c/README.adoc

+5-6
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
= Attaching a LIS3DH Nano Accelerometer via i2c.
22

33
This example shows you how to interface the Raspberry Pi Pico to the LIS3DH accelerometer and temperature sensor.
4-
======
4+
55
The code reads and displays the acceleration values of the board in the 3 axes and the ambient temperature value. The datasheet for the sensor can be found at https://www.st.com/resource/en/datasheet/cd00274221.pdf. The device is being operated on 'normal mode' and at a frequency of 1.344 kHz (this can be changed by editing the ODR bits of CTRL_REG4). The range of the data is controlled by the FS bit in CTRL_REG4 and is equal to ±2g in this example. The sensitivity depends on the operating mode and data range; exact values can be found on page 10 of the datasheet. In this case, the sensitivity value is 4mg (where g is the value of gravitational acceleration on the surface of Earth). In order to use the auxiliary ADC to read temperature, the we must set the BDU bit to 1 in CTRL_REG4 and the ADC_EN bit to 1 in TEMP_CFG_REG. Temperature is communicated through ADC 3.
6-
======
7-
[NOTE]
8-
======
9-
The sensor doesn't have features to eliminate any offsets in the data and they would be needed to be taken into account in the code.
10-
======
116

7+
[NOTE]
8+
=====
9+
The sensor doesn't have features to eliminate offsets in the data and these will need to be taken into account in the code.
10+
=====
1211

1312
== Wiring information
1413

i2c/mcp9808_i2c/README.adoc

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,13 @@
11
= Attaching a MCP9808 digital temperature sensor via I2C
22

33
This example code shows how to interface the Raspberry Pi Pico to the MCP9808 digital temperature sensor board.
4-
======
4+
55
This example reads the ambient temperature value each second from the sensor and sets upper, lower and critical limits for the temperature and checks if alerts need to be raised. The CONFIG register can also be used to check for an alert if the critical temperature is surpassed.
6-
======
76

87
== Wiring information
98

109
Wiring up the device requires 4 jumpers, to connect VDD, GND, SDA and SCL. The example here uses I2C port 0, which is assigned to GPIO 4 (SDA) and 5 (SCL) in software. Power is supplied from the VSYS pin.
1110

12-
13-
1411
[[mcp9808_i2c_wiring]]
1512
[pdfwidth=75%]
1613
.Wiring Diagram for MCP9808.

i2c/mma8451_i2c/README.adoc

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
= Attaching a MMA8451 3-axis digital accelerometer via I2C
22

33
This example code shows how to interface the Raspberry Pi Pico to the MMA8451 digital accelerometer sensor board.
4-
======
4+
55
This example reads and displays the acceleration values of the board in the 3 axis. It also allows the user to set the trade-off between the range and precision based on the values they require. Values often have an offset which can be accounted for by writing to the offset correction registers. The datasheet for the sensor can be found at https://cdn-shop.adafruit.com/datasheets/MMA8451Q-1.pdf for additional information.
6-
======
76

87
== Wiring information
98

i2c/pa1010d_i2c/README.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
= Attaching a PA1010D Mini GPS module via I2C
22

33
This example code shows how to interface the Raspberry Pi Pico to the PA1010D Mini GPS module
4-
======
5-
This allows you read basic location and time data from the Recommended Minimum Specific GNSS Sentence (GNRMC protocol) and displays it in a user-friendly format. The datasheet for the module can be found on https://cdn-learn.adafruit.com/assets/assets/000/084/295/original/CD_PA1010D_Datasheet_v.03.pdf?1573833002. The output sentence is read and parsed to split the data fields into a 2D character array, which are then individually printed out. The commands to use different protocols and change settings are found on https://www.sparkfun.com/datasheets/GPS/Modules/PMTK_Protocol.pdf. Additional protocols can be used by editing the init_command array.
6-
======
4+
5+
This allows you to read basic location and time data from the Recommended Minimum Specific GNSS Sentence (GNRMC protocol) and displays it in a user-friendly format. The datasheet for the module can be found on https://cdn-learn.adafruit.com/assets/assets/000/084/295/original/CD_PA1010D_Datasheet_v.03.pdf?1573833002. The output sentence is read and parsed to split the data fields into a 2D character array, which are then individually printed out. The commands to use different protocols and change settings are found on https://www.sparkfun.com/datasheets/GPS/Modules/PMTK_Protocol.pdf. Additional protocols can be used by editing the `init_command` array.
6+
77
[NOTE]
88
======
99
Each command requires a checksum after the asterisk. The checksum can be calculated for your command using the following website: https://nmeachecksum.eqth.net/.

i2c/pcf8523_i2c/README.adoc

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
= Attaching a PCF8523 Real Time Clock via I2C
22

33
This example code shows how to interface the Raspberry Pi Pico to the PCF8523 Real Time Clock
4-
======
5-
This example allows you to set the current time and date to initialise it and then refreshes it every half-second. Additionally it lets you set an alarm for a particular time + date and raises an alert accordingly. More information about the module is available at https://learn.adafruit.com/adafruit-pcf8523-real-time-clock.
6-
======
4+
5+
This example allows you to initialise the current time and date and then displays it every half-second. Additionally it lets you set an alarm for a particular time and date and raises an alert accordingly. More information about the module is available at https://learn.adafruit.com/adafruit-pcf8523-real-time-clock.
76

87
== Wiring information
98

109
Wiring up the device requires 4 jumpers, to connect VDD, GND, SDA and SCL. The example here uses I2C port 0, which is assigned to GPIO 4 (SDA) and 5 (SCL) in software. Power is supplied from the 5V pin.
1110

12-
1311
[[pcf8523_i2c_wiring]]
1412
[pdfwidth=75%]
1513
.Wiring Diagram for PCF8523.

0 commit comments

Comments
 (0)