From c006a293ad32de509895ebf63efef1b2c1e038ee Mon Sep 17 00:00:00 2001 From: bboyho Date: Fri, 19 Jul 2024 01:45:56 -0600 Subject: [PATCH] Make space for an additional example --- ...ws2812.md => arduino_example_10_ws2812.md} | 0 ...=> arduino_example_11_qwiic_micro_oled.md} | 0 ...e_12_lipo_fuel_gauge_micro_oled_ws2812.md} | 0 docs/arduino_example_7_deep_sleep_blink.md | 19 +----------------- ...d => arduino_example_9_lipo_fuel_gauge.md} | 0 docs/single_page.md | 20 ++++++++++--------- mkdocs.yml | 11 +++++----- 7 files changed, 18 insertions(+), 32 deletions(-) rename docs/{arduino_example_9_ws2812.md => arduino_example_10_ws2812.md} (100%) rename docs/{arduino_example_10_qwiic_micro_oled.md => arduino_example_11_qwiic_micro_oled.md} (100%) rename docs/{arduino_example_11_lipo_fuel_gauge_micro_oled_ws2812.md => arduino_example_12_lipo_fuel_gauge_micro_oled_ws2812.md} (100%) rename docs/{arduino_example_8_lipo_fuel_gauge.md => arduino_example_9_lipo_fuel_gauge.md} (100%) diff --git a/docs/arduino_example_9_ws2812.md b/docs/arduino_example_10_ws2812.md similarity index 100% rename from docs/arduino_example_9_ws2812.md rename to docs/arduino_example_10_ws2812.md diff --git a/docs/arduino_example_10_qwiic_micro_oled.md b/docs/arduino_example_11_qwiic_micro_oled.md similarity index 100% rename from docs/arduino_example_10_qwiic_micro_oled.md rename to docs/arduino_example_11_qwiic_micro_oled.md diff --git a/docs/arduino_example_11_lipo_fuel_gauge_micro_oled_ws2812.md b/docs/arduino_example_12_lipo_fuel_gauge_micro_oled_ws2812.md similarity index 100% rename from docs/arduino_example_11_lipo_fuel_gauge_micro_oled_ws2812.md rename to docs/arduino_example_12_lipo_fuel_gauge_micro_oled_ws2812.md diff --git a/docs/arduino_example_7_deep_sleep_blink.md b/docs/arduino_example_7_deep_sleep_blink.md index 5b3ef64..b51349c 100644 --- a/docs/arduino_example_7_deep_sleep_blink.md +++ b/docs/arduino_example_7_deep_sleep_blink.md @@ -50,7 +50,7 @@ To upload code, connect the USB cable to the SparkFun Thing Plus NORA-W306. Of c This example builds upon Realtek's deep sleep mode. Once the deep sleep modes are set up, the NORA-W306 goes into deep sleep. In this particular example, we will use the timer (i.e. `SET_DS_AON_TIMER_WAKEUP`) as the source. After 5 seconds, the board wakes up with the user LED also blinking five times before going back to deep sleep for 5 seconds. !!! note - The serial UART is disabled to reduce amount the peripherals that are turned on. To save more power, you can cut the JP3 and PWR LED jumpers. There is also a fancy circuit to disable power to the CP2102 when there is no USB power. Users that decide to + The serial UART is disabled to reduce amount the peripherals that are turned on. To save more power, you can cut the JP3 and PWR LED jumpers. There is also a fancy circuit to disable power to the CP2102 when there is no USB power. As an alternative to USB power, users can power the board with a LiPo battery. Copy and paste the following code in the Arduino IDE. Select your Board (in this case the **SparkFun Thing Plus NORA-W306 (RTL8720DF)**), and associated COM port (in this case **COM13**). Then hit the upload button. @@ -305,20 +305,3 @@ Below are a few diagrams showing two possible to measure the current draw when t - - -!!! note - For the SD power control (SDPC), make sure to cut the trace on the back of the board and add a solder blob between the center pad and pad labelled as `17`. Head back to the Arduino code and uncomment the lines for the SD power control (i.e. where SDPC). - -
- - - - - - - -
MicroSD Card Power Control Jumper Modified
MicroSD Card Power Control Jumper Modified
-
- - For those that are reading and writing to the microSD card, you will need to write just a bit more code as well. Check out the code for the [microSD card example](../arduino_example_6_microsd/#arduino-code). Besides setting up the microSD card, you will need to open a file, write/read, and close the file where the LED blinks before turning power off the SDPC pin. Make sure to insert a microSD card into the socket on the back of the board before powering up the board. diff --git a/docs/arduino_example_8_lipo_fuel_gauge.md b/docs/arduino_example_9_lipo_fuel_gauge.md similarity index 100% rename from docs/arduino_example_8_lipo_fuel_gauge.md rename to docs/arduino_example_9_lipo_fuel_gauge.md diff --git a/docs/single_page.md b/docs/single_page.md index eddf0bd..d464526 100644 --- a/docs/single_page.md +++ b/docs/single_page.md @@ -46,20 +46,22 @@ icon: fontawesome/solid/scroll # Example 6 - MicroSD Card --8<-- "./docs/arduino_example_6_microsd.md" -# Example 7 - Deep Sleep and MicroSD Power Control +# Example 7 - Deep Sleep and Blink --8<-- "./docs/arduino_example_7_deep_sleep_blink.md" -# Example 8 - MAX17048 LiPo Fuel Gauge ---8<-- "./docs/arduino_example_8_lipo_fuel_gauge.md" -# Example 9 - WS2812 Addressable RGB LED ---8<-- "./docs/arduino_example_9_ws2812.md" -# Example 10 - Qwiic Micro OLED ---8<-- "./docs/arduino_example_10_qwiic_micro_oled.md" +# Example 9 - MAX17048 LiPo Fuel Gauge +--8<-- "./docs/arduino_example_9_lipo_fuel_gauge.md" -# Example 11 - LiPo Fuel Gauge (MAX17048) with Micro OLED Display Demo ---8<-- "./docs/arduino_example_11_lipo_fuel_gauge_micro_oled_ws2812.md" +# Example 10 - WS2812 Addressable RGB LED +--8<-- "./docs/arduino_example_10_ws2812.md" + +# Example 11 - Qwiic Micro OLED +--8<-- "./docs/arduino_example_11_qwiic_micro_oled.md" + +# Example 12 - LiPo Fuel Gauge (MAX17048) with Micro OLED Display Demo +--8<-- "./docs/arduino_example_12_lipo_fuel_gauge_micro_oled_ws2812.md" # More Examples!!! --8<-- "./docs/more_examples.md" diff --git a/mkdocs.yml b/mkdocs.yml index af18699..66c161a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -251,11 +251,12 @@ nav: - Example 5a - Bluetooth UART Service: arduino_example_5a_bluetooth_uart_service.md - Example 5b - Bluetooth UART Client: arduino_example_5b_bluetooth_uart_client.md - Example 6 - MicroSD Card: arduino_example_6_microsd.md - - Example 7 - Deep Sleep and MicroSD Power Control: arduino_example_7_deep_sleep_blink.md - - Example 8 - MAX17048 LiPo Fuel Gauge: arduino_example_8_lipo_fuel_gauge.md - - Example 9 - WS2812 Addressable RGB LED: arduino_example_9_ws2812.md - - Example 10 - Qwiic Micro OLED: arduino_example_10_qwiic_micro_oled.md - - Example 11 - MAX17048 LiPo Fuel Gauge with Micro OLED Display Demo: arduino_example_11_lipo_fuel_gauge_micro_oled_ws2812.md + - Example 7 - Deep Sleep and Blink: arduino_example_7_deep_sleep_blink.md + # - Example 8 - Deep Sleep and MicroSD Temperature DataLogging: arduino_example_8_deep_sleep_microSD_datalogging.md + - Example 9 - MAX17048 LiPo Fuel Gauge: arduino_example_9_lipo_fuel_gauge.md + - Example 10 - WS2812 Addressable RGB LED: arduino_example_10_ws2812.md + - Example 11 - Qwiic Micro OLED: arduino_example_11_qwiic_micro_oled.md + - Example 12 - MAX17048 LiPo Fuel Gauge with Micro OLED Display Demo: arduino_example_12_lipo_fuel_gauge_micro_oled_ws2812.md - More Examples!!!: more_examples.md - Resources: resources.md - Support: