Skip to content

Commit 4284d15

Browse files
Update Docs
- Removed extra spaces from end of lines - Add languages highlights to code blocks - Remove links to technical assistance page - Added related products - Updated page styling for build
1 parent cb770bf commit 4284d15

10 files changed

Lines changed: 123 additions & 94 deletions

File tree

Firmware/Example3_Display/Example3_Display.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ void loop()
8686
lastLipoCheck = millis();
8787
voltage = lipo.getVoltage();
8888
soc = lipo.getSOC();
89-
89+
9090
Serial.print("Voltage: ");
9191
Serial.print(voltage); // Print the battery voltage
9292
Serial.println(" V");

docs/arduino_example.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ icon: simple/arduino
66

77
This example demonstrates how to use the navigation switch and detect if the SD card is inserted. The !INT pin of the GPIO expander IC (PCA9554) triggers an interrupt any time a button is pressed or an SD card is inserted/removed.
88

9-
The code for this example can be found in the [Firmware](../Firmware/Example1_NavigationSwitch/) folder of this repository. Alternatively, you can expand the link below and copy and paste the code into a shiny new Arduino sketch:
9+
The code for this example can be found in the [Firmware](../Firmware/Example1_NavigationSwitch/) folder of this repository. Alternatively, you can expand the link below and copy and paste the code into a shiny new Arduino sketch:
1010

1111
??? "Example 1 Arduino Code"
12-
```
12+
```c++
1313
--8<-- "https://raw.githubusercontent.com/sparkfun/SparkFun_Portability_Shield/refs/heads/main/Firmware/Example1_NavigationSwitch/Example1_NavigationSwitch.ino"
1414
```
1515

1616

17-
One thing to note is that you will also need to install the SparkFun I2C Expander Arduino Library if you haven't already. You can search the library from within the Arduino Library manager, download the zip from [the GitHub Repository](https://github.com/sparkfun/SparkFun_I2C_Expander_Arduino_Library/archive/refs/heads/main.zip) and install it manually, or you can click the link from within the code. Clicking the link will show something like the following:
17+
One thing to note is that you will also need to install the SparkFun I2C Expander Arduino Library if you haven't already. You can search the library from within the Arduino Library manager, download the zip from [the GitHub Repository](https://github.com/sparkfun/SparkFun_I2C_Expander_Arduino_Library/archive/refs/heads/main.zip) and install it manually, or you can click the link from within the code. Clicking the link will show something like the following:
1818

1919
<figure markdown>
2020
[![SparkFun I2C Expander Arduino Library Install](assets/img/I2CExpanderLibraryInstall.png){ width="90%" }](assets/img/I2CExpanderLibraryInstall.png "Click to enlarge")
@@ -23,7 +23,7 @@ One thing to note is that you will also need to install the SparkFun I2C Expande
2323

2424

2525

26-
Make sure you've selected the correct board (in this case, you will need to use ESP32 Dev Module from espressif) and port in the Tools menu and then hit the upload button. Once the code has finished uploading, go ahead and open a [Serial Monitor](https://learn.sparkfun.com/tutorials/terminal-basics). You should see something similar to the following.
26+
Make sure you've selected the correct board (in this case, you will need to use ESP32 Dev Module from espressif) and port in the Tools menu and then hit the upload button. Once the code has finished uploading, go ahead and open a [Serial Monitor](https://learn.sparkfun.com/tutorials/terminal-basics). You should see something similar to the following.
2727

2828
<figure markdown>
2929
[![Arduino Example 1 Output](assets/img/Example1_Output.png){ width="90%" }](assets/img/Example1_Output.png "Click to enlarge")
@@ -32,25 +32,25 @@ Make sure you've selected the correct board (in this case, you will need to use
3232

3333

3434
###Example 2: Fuel Gauge
35-
This file demonstrates the simple API of the SparkFun MAX17043 Arduino library. Make sure you have a LiPo battery plugged into the JST port.
35+
This file demonstrates the simple API of the SparkFun MAX17043 Arduino library. Make sure you have a LiPo battery plugged into the JST port.
3636

37-
The code for this example can be found in the [Firmware](../Firmware/Example2_FuelGauge/) folder of this repository. Alternatively, you can expand the link below and copy and paste the code into a shiny new Arduino sketch:
37+
The code for this example can be found in the [Firmware](../Firmware/Example2_FuelGauge/) folder of this repository. Alternatively, you can expand the link below and copy and paste the code into a shiny new Arduino sketch:
3838

3939
??? "Example 2 Arduino Code"
40-
```
40+
```c++
4141
--8<-- "https://github.com/sparkfun/SparkFun_Portability_Shield/raw/refs/heads/main/Firmware/Example2_FuelGauge/Example2_FuelGauge.ino"
4242
```
4343

44-
You will also need to install the SparkFun MAX1704x Fuel Gauge Arduino Library if you haven't already. You can search the library from within the Arduino Library manager, download the zip from [the GitHub Repository](https://github.com/sparkfun/SparkFun_MAX1704x_Fuel_Gauge_Arduino_Library/archive/refs/heads/main.zip) and install it manually, or you can click the link from within the code. Clicking the link will show something like the following:
45-
44+
You will also need to install the SparkFun MAX1704x Fuel Gauge Arduino Library if you haven't already. You can search the library from within the Arduino Library manager, download the zip from [the GitHub Repository](https://github.com/sparkfun/SparkFun_MAX1704x_Fuel_Gauge_Arduino_Library/archive/refs/heads/main.zip) and install it manually, or you can click the link from within the code. Clicking the link will show something like the following:
45+
4646

4747
<figure markdown>
4848
[![SparkFun MAX1704x Fuel Gauge Arduino Library Install](assets/img/MAX17043LibraryInstall.png){ width="90%" }](assets/img/MAX17043LibraryInstall.png "Click to enlarge")
4949
<figcaption markdown>SparkFun MAX1704x Fuel Gauge Arduino Library Install</figcaption>
5050
</figure>
5151

5252

53-
Make sure you've selected the correct board and port in the Tools menu and then hit the upload button. Once the code has finished uploading, go ahead and open a [Serial Monitor](https://learn.sparkfun.com/tutorials/terminal-basics) at 115200 baud. You should see the gauge's voltage and state-of-charge (SOC) readings, similar to the following:
53+
Make sure you've selected the correct board and port in the Tools menu and then hit the upload button. Once the code has finished uploading, go ahead and open a [Serial Monitor](https://learn.sparkfun.com/tutorials/terminal-basics) at 115200 baud. You should see the gauge's voltage and state-of-charge (SOC) readings, similar to the following:
5454

5555
<figure markdown>
5656
[![Arduino Example 2 Output](assets/img/Example2_Output.jpg){ width="90%" }](assets/img/Example2_Output.jpg "Click to enlarge")
@@ -61,20 +61,20 @@ Make sure you've selected the correct board and port in the Tools menu and then
6161

6262
###Example 3: Display
6363

64-
This example demonstrates how to display on the 1.3" OLED and read the fuel gauge. You should have the Portability Shield connected to the RTK Postcard or other controller and a LiPo battery plugged into the JST port.
64+
This example demonstrates how to display on the 1.3" OLED and read the fuel gauge. You should have the Portability Shield connected to the RTK Postcard or other controller and a LiPo battery plugged into the JST port.
6565

66-
The code for this example can be found in the [Firmware](../Firmware/Example3_Display/) folder of this repository. Alternatively, you can expand the link below and copy and paste the code into a shiny new Arduino sketch:
66+
The code for this example can be found in the [Firmware](../Firmware/Example3_Display/) folder of this repository. Alternatively, you can expand the link below and copy and paste the code into a shiny new Arduino sketch:
6767

6868
??? "Example 3 Arduino Code"
69-
```
69+
```c++
7070
--8<-- "https://raw.githubusercontent.com/sparkfun/SparkFun_Portability_Shield/refs/heads/main/Firmware/Example3_Display/Example3_Display.ino"
7171
```
7272

73-
You will also need both the SparkFun Qwiic OLED Arduino Library as well as the SparkFun MAX1704x Fuel Gauge Arduino Library. If you haven't already installed these, you can search them from within the Arduino Library manager and install them from there. Alternatively, you can download the zips from their respective GitHub Repositories [here(Fuel Gauge)](https://github.com/sparkfun/SparkFun_MAX1704x_Fuel_Gauge_Arduino_Library/archive/refs/heads/main.zip) and [here(Qwiic OLED)](https://github.com/sparkfun/SparkFun_Qwiic_OLED_Arduino_Library/archive/refs/heads/main.zip), and install them manually.
73+
You will also need both the SparkFun Qwiic OLED Arduino Library as well as the SparkFun MAX1704x Fuel Gauge Arduino Library. If you haven't already installed these, you can search them from within the Arduino Library manager and install them from there. Alternatively, you can download the zips from their respective GitHub Repositories [here(Fuel Gauge)](https://github.com/sparkfun/SparkFun_MAX1704x_Fuel_Gauge_Arduino_Library/archive/refs/heads/main.zip) and [here(Qwiic OLED)](https://github.com/sparkfun/SparkFun_Qwiic_OLED_Arduino_Library/archive/refs/heads/main.zip), and install them manually.
7474

7575

76-
Make sure you've selected the correct board and port in the Tools menu and then hit the upload button. Once the code has finished uploading, you should see the gauge's voltage and state-of-charge (SOC) readings, similar to the the output for Example 2.
77-
The 1.3" OLED display should show a bouncing box like so:
76+
Make sure you've selected the correct board and port in the Tools menu and then hit the upload button. Once the code has finished uploading, you should see the gauge's voltage and state-of-charge (SOC) readings, similar to the the output for Example 2.
77+
The 1.3" OLED display should show a bouncing box like so:
7878

7979

8080
<figure markdown>
@@ -87,23 +87,23 @@ The 1.3" OLED display should show a bouncing box like so:
8787

8888
###Example 4: SD Card
8989

90-
This example will mount an SD card, analyze the type of card, and output the analysis via the Serial Monitor.
90+
This example will mount an SD card, analyze the type of card, and output the analysis via the Serial Monitor.
9191

9292
Go ahead and connect the Portability Shield to the RTK Postcard or other controller board. Insert a microSD card into the socket. Cards up to 512GB should work.
9393

94-
The code for this example can be found in the [Firmware](../Firmware/Example4_SD/) folder of this repository. Alternatively, you can expand the link below and copy and paste the code into a shiny new Arduino sketch:
94+
The code for this example can be found in the [Firmware](../Firmware/Example4_SD/) folder of this repository. Alternatively, you can expand the link below and copy and paste the code into a shiny new Arduino sketch:
9595

9696
??? "Example 4 Arduino Code"
97-
```
97+
```c++
9898
--8<-- "https://github.com/sparkfun/SparkFun_Portability_Shield/raw/refs/heads/main/Firmware/Example4_SD/Example4_SD.ino"
9999
```
100100

101101

102102

103-
You will also need to install the SDFat Arduino Library if you haven't already. You can search the library from within the Arduino Library manager, download the zip from [the GitHub Repository](https://github.com/sparkfun/SparkFun_Qwiic_OLED_Arduino_Library/archive/refs/heads/main.zip) and install it manually, or you can click the link from within the code.
104-
103+
You will also need to install the SDFat Arduino Library if you haven't already. You can search the library from within the Arduino Library manager, download the zip from [the GitHub Repository](https://github.com/sparkfun/SparkFun_Qwiic_OLED_Arduino_Library/archive/refs/heads/main.zip) and install it manually, or you can click the link from within the code.
104+
105105

106-
Make sure you've selected the correct board and port in the Tools menu and then hit the upload button. Once the code has finished uploading, go ahead and open a [Serial Monitor](https://learn.sparkfun.com/tutorials/terminal-basics) at 115200 baud. Once you type in any key in the Message Field and send it, the code will analyze the SD card and output something similar to the following:
106+
Make sure you've selected the correct board and port in the Tools menu and then hit the upload button. Once the code has finished uploading, go ahead and open a [Serial Monitor](https://learn.sparkfun.com/tutorials/terminal-basics) at 115200 baud. Once you type in any key in the Message Field and send it, the code will analyze the SD card and output something similar to the following:
107107

108108
<figure markdown>
109109
[![Arduino Example 4 Output](assets/img/Example4_Output.png){ width="90%" }](assets/img/Example4_Output.png "Click to enlarge")

docs/github/file_issue.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,11 @@ Spot something wrong? Please let us know. <a href="https://github.com/sparkfun/S
44

55
<!-- Technical Assistance Box -->
66
!!! warning "Need Help?"
7-
If you need technical assistance or more information on a product that is not working as you expected, we recommend heading on over to the [SparkFun Technical Assistance](https://www.sparkfun.com/technical_assistanc) page for some initial troubleshooting. This **Submit Issues** page is not where users should seek assistance.
8-
9-
<center>
10-
[SparkFun Technical Assistance Page](https://www.sparkfun.com/technical_assistance){ .md-button .md-button--primary }
11-
</center>
12-
13-
If you can't find what you need there, the [SparkFun Forums](https://forum.sparkfun.com/index.php) is a great place to search the product forums and ask questions.
14-
15-
!!! info "Account Registration Required"
16-
For your first visit to our forum, you'll need to create a [Forum Account](https://forum.sparkfun.com/ucp.php?mode=register) to post questions.
7+
If you need technical assistance or more information on a product that is not working as you expected, we recommend heading on over to the [SparkFun Forums](https://community.sparkfun.com).
8+
9+
10+
!!! info "Account Registration Required"
11+
If this is your first visit to our forum, you'll need to create a [Forum Account](https://community.sparkfun.com/signup) to post questions.
1712

1813

1914
## Discrepancies in the Documentation

docs/hardware_assembly.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
icon: fontawesome/solid/screwdriver-wrench
33
---
44

5-
The Portability Shield has been designed to be usable with any compatible main board. Here we have soldered in headers and it is plugged into the [RTK Postcard](https://www.sparkfun.com/products/26916). Note that there is an antenna attached to the module, as well as a LiPo battery plugged into the JST port.
5+
The Portability Shield has been designed to be usable with any compatible main board. Here we have soldered in headers and it is plugged into the [RTK Postcard](https://www.sparkfun.com/products/26916). Note that there is an antenna attached to the module, as well as a LiPo battery plugged into the JST port.
66

77

88
<figure markdown>

0 commit comments

Comments
 (0)