Skip to content

Commit 88780a2

Browse files
committed
fixing fixing fixing
1 parent 1564482 commit 88780a2

5 files changed

Lines changed: 30 additions & 163 deletions

File tree

221 KB
Loading
109 KB
Loading
114 KB
Loading
146 KB
Loading

docs/configuration.md

Lines changed: 30 additions & 163 deletions
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,7 @@ In the Application Settings Menu, users will be able to configure the addressabl
222222
* **Startup Messages** Level of message output at startup
223223
* **Startup Delay** Startup Menu Delay in Seconds
224224
* **Device Names** Name always includes the device address
225+
* **Verbose Messages** Enable verbose messaging
225226
* **About...** - Details about the system
226227

227228
!!! note
@@ -590,27 +591,17 @@ Log files can be viewed and downloaded using the IoT Web Server feature if mDNS
590591

591592
This functionality is accessed by selecting the IoT Web Server menu. Once this menu entry is selected, the following menu options are presented:
592593

593-
![IoT Web Server Options](assets/sparkfun_datalogger_iot_web_server_menu.jpg)
594+
![IoT Web Server Options](assets/sfe-datalogger-web-server.png)
594595
/// caption
595596
IoT Web Server Options
596597
///
597598

598-
* ```1``` **Enabled** - Enabled or Disable the Web Server
599-
* Accepts a boolean value
600-
* ```1``` to enable
601-
* ```0``` to disable _(default)_
602-
* ```2``` **Username** - Web access control. Leave empty to disable authentication
603-
* Accepts a string
604-
* ```3``` **Password** - Web access control.
605-
* Accepts a string
606-
* ```4``` **mDNS Support** - Enable a name for the web address this device
607-
* Accepts a boolean value
608-
* ```1``` to enable
609-
* ```0``` to disable _(default)_
610-
* ```5``` **mDNS Name** - mDNS Name used for this device address
611-
* Accepts a string
612-
* dataloggerXXXXX, where XXXXX is the taken from the last 5x characters from your DataLogger IoT's board ID _(default)_
613-
* ```b``` **Back**
599+
* **Enabled** - Enabled or Disable the Web Server
600+
* **Username** - Web access control. Leave empty to disable authentication
601+
* **Password** - Web access control.
602+
* **mDNS Support** - Enable a name for the web address this device
603+
* **mDNS Name** - mDNS Name used for this device address
604+
* dataloggerXXXXX, where XXXXX is the taken from the last 5x characters from your DataLogger IoT's board ID _(default)_
614605

615606
You will need to make sure that the ESP32 is on the same network as your computer in order to access the log files.
616607

@@ -621,6 +612,9 @@ The SparkFun Datalogger IoT requires restarting if the web interface is enabled.
621612
For more information on how to use this feature, check out the [section on viewing and downloading log files using the IoT web server](../example_iot_web_server/).
622613

623614
[Examples: Viewing and Downloading Log Files using the IoT Web Server](../example_iot_web_server)
615+
/// caption
616+
Viewing Log Files using the Web Server
617+
///
624618

625619
### Advanced: System Update
626620

@@ -630,163 +624,36 @@ New sensors and features are being added all the time and we've made it really e
630624
* Performing a Factory Reset on the device
631625
* Updated the device firmware from a file on an SD Card.
632626

633-
!!! note
634-
What's going on here?!? This tutorial was updated for firmware version **01.02.00**!!! You will notice this menu option has changed to ```18``` !!!
635-
636627
This functionality is accessed via the Settings Menu, which is required to use this capability. Type ```18``` to enter the System Update menu. Once this menu entry is selected, the following menu options are presented:
637628

638-
![System Update Menu Options](assets/sparkfun_datalogger_iot_system_restart_factory_restore_update_firmware_v01p02p00.jpg "System Update Menu Options")
639-
640-
* ```1``` **Device Restart** - Restart/reboot the device
641-
* Accepts the following values:
642-
* ```Y``` or ```Y``` to restart or reboot the device using the current firmware and system preferences
643-
* ```N``` or ```n``` to cancel
644-
* ```2``` **Factory Reset** - Erase all settings and revert to original firmware
645-
* Accepts the following values:
646-
* ```Y``` or ```Y``` to factory reset the device
647-
* ```N``` or ```n``` to cancel
648-
* ```3``` **Update Firmware - SD Card** - Update the firmware from the SD card
649-
* Accepts firmware in the **/root** directory of the microSD card with the file naming pattern __SparkFunDataLoggerIoT_.bin_*, where the asterisk ***** is the firmware version number (i.e. **SparkFunDataLoggerIoT_01.00.01.bin**).
650-
* ```4``` **Update Firmware - OTA** - Update the firmware over-the-air
651-
* Connects to a server and searches for the latest firmware that is available. Note that you must be connected to a WiFi network to be able to update the board over-the-air.
652-
* Accepts the following values if there is new firmware available.
653-
* ```Y``` or ```Y``` to update over-the-air
654-
* ```N``` or ```n``` to cancel
655-
* ```b``` **Back**
629+
![System Update Menu Options](assets/sfe-datalogger-update.png)
630+
/// caption
631+
System Update Menu Options
632+
///
656633

657-
When finished, you will need to exit the menus so that the DataLogger IoT saves the changes. Send a ```b``` to exit out this menu, ```b``` to exit out of the DataLogger IoT settings, and ```x``` to exit out of the main menu.
658-
![Output Save Settings Confirmation](assets/sparkfun_datalogger_iot_system_save_settings_menu.jpg "Output Save Settings Confirmation")
634+
* **Device Restart** - Restart/reboot the device
635+
* **Factory Reset** - Erase all settings and revert to original firmware
636+
* **Update Firmware - SD Card** - Update the firmware from the SD card
637+
* **Update Firmware - OTA** - Update the firmware over-the-air
659638

660639
For more information on how to update firmware manually or over-the-air, check out the section under [Examples: Updating Firmware](../updating_firmware/).
661640

662641
## Device Settings
663642

664643
In the Main Menu, send a ```2``` through the serial terminal to adjust the devices settings.
665644

666-
![Device Settings Menu Options](assets/sparkfun_datalogger_iot_device_settings_menu.jpg "Device Settings Menu Options")
667-
668-
This will bring up the connected devices that are currently available. You can configure each device and enable/disable each output. Below is a sample of the on-board devices available for the DataLogger IoT - 9DoF when only the MAX17048, ISM330, and MMC5983 are connected. As the DataLogger IoT - 9DoF initializes, the board will populate additional devices in this window if they are detected. Your mileage will vary depending on what is connected. On the DataLogger IoT you will not see the ISM330 or MMC5983 as an option since the 6DoF IMU and magnetometer are not populated on that version of the board.
669-
670-
* ```1``` **MAX17048** - MAX17048 LiPo Battery Fuel Gauge
671-
* ```1``` **Voltage (V)** - Battery voltage (Volts)
672-
* ```1``` to enable Voltage (V) _(default)_
673-
* ```2``` to disable Voltage (V)
674-
* ```2``` **State of Charge (%)** - Battery state of charge (%)
675-
* ```1``` to enable state of charge (%) _(default)_
676-
* ```2``` to disable state of charge (%)
677-
* ```3``` **Charge Rate (%/hr)** - Battery charge change rate (%/hr)
678-
* ```1``` to enable change rate (%/hr) _(default)_
679-
* ```2``` to disable change rate (%/hr)
680-
* ```2``` **ISM330** - ISM330 Inertial Measurement Unit
681-
* ```1``` **Accel Data Rate (HZ)** - Accelerometer Data Rate (Hz)
682-
* ```1``` for Off
683-
* ```2``` for 12.5 Hz
684-
* ```3``` for 26 Hz
685-
* ```4``` for 52 Hz
686-
* ```5``` for 104 Hz _(default)_
687-
* ```6``` for 208 Hz
688-
* ```7``` for 416 Hz
689-
* ```8``` for 833 Hz
690-
* ```9``` for 1666 Hz
691-
* ```10``` for 3332 Hz
692-
* ```11``` for 6667 Hz
693-
* ```12``` for 1.6 Hz
694-
* ```2``` **Accel Full Scale (g)** - Accelerometer Full Scall (g)
695-
* ```1``` for 2 g
696-
* ```2``` for 16 g
697-
* ```3``` for 4 g _(default)_
698-
* ```4``` for 8 g
699-
* ```3``` **Gyro Data Rate (Hz)** - Gyro Data Rate (Hz)
700-
* ```1``` for Off
701-
* ```2``` for 12.5 Hz
702-
* ```3``` for 26 Hz
703-
* ```4``` for 52 Hz
704-
* ```5``` for 104 Hz _(default)_
705-
* ```6``` for 208 Hz
706-
* ```7``` for 416 Hz
707-
* ```8``` for 833 Hz
708-
* ```9``` for 1666 Hz
709-
* ```10``` for 3332 Hz
710-
* ```11``` for 6667 Hz
711-
* ```4``` **Gyro Full Scale (dps)** - Gyro Full Scale (dps)
712-
* ```1``` for 125 dps
713-
* ```2``` for 250 dps
714-
* ```3``` for 500 dps _(default)_
715-
* ```4``` for 1000 dps
716-
* ```5``` for 2000 dps
717-
* ```6``` for 4000 dps
718-
* ```5``` **Accel Filter LP2** - Accelerometer Filter LP2
719-
* ```1``` to enable _(default)_
720-
* ```2``` to disable
721-
* ```6``` **Gyro Filter LP1** - Gyro Filter LP1
722-
* ```1``` to enable _(default)_
723-
* ```2``` to disable
724-
* ```7``` **Accel Slope Filter** - Accelerometer Slope Filter
725-
* ```1``` for ODR/4
726-
* ```2``` for ODR/10
727-
* ```3``` for for ODR/20
728-
* ```4``` for ODR/45
729-
* ```5``` for ODR/100 _(default)_
730-
* ```6``` for ODR/200
731-
* ```7``` for ODR/400
732-
* ```8``` for ODR/800
733-
* ```8``` **Gyro LP1 Filter Bandwidth** - Gyro LP1 Filter Bandwidth
734-
* ```1``` Ultra Light
735-
* ```2``` Very Light
736-
* ```3``` Light
737-
* ```4``` Medium _(default)_
738-
* ```5``` Strong
739-
* ```6``` Very Strong
740-
* ```7``` Aggressive
741-
* ```8``` Extreme
742-
* ```9``` **Accel X (milli-g)** - Accelerometer X (milli-g)
743-
* ```1``` to enable
744-
* ```2``` to disable
745-
* ```10``` **Accel Y (milli-g)** - Accelerometer Y (milli-g)
746-
* ```1``` to enable
747-
* ```2``` to disable
748-
* ```11``` **Accel Z (milli-g)** - Accelerometer Z (milli-g)
749-
* ```1``` to enable
750-
* ```2``` to disable
751-
* ```12``` **Gyro X (milli-dps)** - Gyro X (milli-g)
752-
* ```1``` to enable
753-
* ```2``` to disable
754-
* ```13``` **Gyro Y (milli-dps)** - Gyro Y (milli-g)
755-
* ```1``` to enable
756-
* ```2``` to disable
757-
* ```14``` **Gyro Z (milli-dps)** - Gyro Z (milli-g)
758-
* ```1``` to enable
759-
* ```2``` to disable
760-
* ```15``` **Temperature (C)** - The temperature in degrees C
761-
* ```1``` to enable
762-
* ```2``` to disable
763-
* ```3``` **MMC5983** - MMC5983 Magnetometer
764-
* ```1``` **Filter Bandwidth (Hz)** - The filter bandwidth in Hz
765-
* ```1``` 100 Hz _(default)_
766-
* ```2``` 200 Hz
767-
* ```3``` 400 Hz
768-
* ```4``` 800 Hz
769-
* ```2``` **Auto-Reset** - Auto-Reset
770-
* ```1``` to enable
771-
* ```2``` to disable
772-
* ```3``` **X Field (Gauss)** - The X Field strength in Gauss
773-
* ```1``` to enable
774-
* ```2``` to disable
775-
* ```4``` **Y Field (Gauss)** - The Y Field strength in Gauss
776-
* ```1``` to enable
777-
* ```2``` to disable
778-
* ```5``` **Z Field (Gauss)** - The Z Field strength in Gauss
779-
* ```1``` to enable
780-
* ```2``` to disable
781-
* ```6``` **Temperature (C)** - The ambient temperature in degrees C
782-
* ```1``` to enable
783-
* ```2``` to disable
784-
* ```b``` **Back**
645+
![Device Settings Menu Options](assets/sfe-datalogger-dev-menu.png)
646+
/// caption
647+
Device Settings Menu Options
648+
///
785649

786-
When finished, you will need to exit the menus so that the DataLogger IoT saves the changes. Send a ```b``` to exit out this menu, ```b``` to exit out of the DataLogger IoT settings, and ```x``` to exit out of the main menu.
650+
This will bring up the connected devices that are currently available. Selecting a connected device allows you to configure settings for that particular device as well as enable/disable output values from the device.
787651

788-
![Output Save Settings Confirmation](assets/sparkfun_datalogger_iot_system_save_settings_menu.jpg "Output Save Settings Confirmation")
652+
The following is an example settings page for the SparkFun BMV080 Environmental Sensor:
789653

790-
As you connect additional devices to the DataLogger IoT, the values associated with each device in this menu will change! Make sure to check your device settings menu after additional devices are attached should you decide to configure the additional devices and enable/disable their outputs.
654+
![BMV080 Settings](assets/sfe-datalogger-bmv080-settings.png)
655+
/// caption
656+
BMV080 Device Settings Page
657+
///
791658

792-
![Additional Devices Connected and Showing Up as Menu Options](assets/sparkfun_datalogger_iot_device_settings_menu_additional_devices.jpg)
659+
As you connect additional devices to the DataLogger IoT, the values associated with each device in this menu will change! Make sure to check your device settings menu after additional devices are attached should you decide to configure the additional devices and enable/disable their outputs.

0 commit comments

Comments
 (0)