Skip to content

Commit 0dd096c

Browse files
committed
Update system_configuration.md
1 parent 19c22f5 commit 0dd096c

File tree

1 file changed

+8
-72
lines changed

1 file changed

+8
-72
lines changed

docs/system_configuration.md

Lines changed: 8 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,13 @@
1-
# Connecting Over WiFi
1+
# System Configuration
22

3+
Surveyor: Yes / Express: Yes / Express Plus: Yes / Facet: Yes
34

4-
## Installation
5+
All device settings are stored both in internal memory and an SD card if one is detected. The device will load the latest settings at each power on. If there is a discrepancy between the internal settings and a settings file then the settings file will be used. This allows a collection of RTK products to be identically configured using one 'golden' settings file loaded onto an SD card.
56

6-
The SparkFun Qwiic OLED Arduino Library is available within in the Arduino library manager, which is launched via the `Sketch > Include Libraries > Manage Libraries …` menu option in the Arduino IDE. Just search for ***SparkFun Qwiic OLED Library***
7-
8-
!!! note
9-
This guide assumes you are using the latest version of the Arduino IDE on your desktop. The following resources available at [SparkFun](https://www.sparkfun.com) provide the details on setting up and configuring Arduino to use this library.
10-
11-
- [Installing the Arduino IDE](https://learn.sparkfun.com/tutorials/installing-arduino-ide)
12-
- [Installing Board Definitions in the Arduino IDE](https://learn.sparkfun.com/tutorials/installing-board-definitions-in-the-arduino-ide)
13-
- [Installing an Arduino Library](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)
14-
15-
General Use Pattern
16-
---------
17-
After installing this library in your local Arduino environment, begin with a standard Arduino sketch, and include the header file for this library.
18-
```C++
19-
// Include the SparkFun qwiic OLED Library
20-
#include <SparkFun_Qwiic_OLED.h>
21-
```
22-
The next step is to declare the object for the SparkFun qwiic OLED device used. Like most Arduino sketches, this is done at a global scope (after the include file declaration), not within the ```setup()``` or ```loop()``` functions.
23-
24-
The user selects from one of the following classes:
25-
26-
| Class | Qwiic OLED Device |
27-
| :--- | :--- |
28-
| `QwiicMicroOLED` | [SparkFun Qwiic Micro OLED ]( https://www.sparkfun.com/products/14532)|
29-
| `QwiicNarrowOLED` | [SparkFun Qwiic OLED Display (128x32) ]( https://www.sparkfun.com/products/17153)|
30-
| `QwiicTransparentOLED` | [SparkFun Transparent Graphical OLED]( https://www.sparkfun.com/products/15173)|
31-
32-
For this example, the Qwiic Micro OLED is used.
33-
```C++
34-
QwiicMicroOLED myOLED;
35-
```
36-
In the ```setup()``` function of this sketch, like all of the SparkFun qwiic libraries, the device is initialized by calling the ```begin()``` method. This method returns a value of ```true``` on success, or ```false``` on failure.
37-
```C++
38-
int width, height; // global variables for use in the sketch
39-
void setup()
40-
{
41-
Serial.begin(115200);
42-
if(!myOLED.begin()){
43-
Serial.println("Device failed to initialize");
44-
while(1); // halt execution
45-
}
46-
Serial.println("Device is initialized");
47-
48-
}
49-
```
50-
Now that the library is initialized, the desired graphics are drawn. Here we erase the screen and draw simple series of lines that originate at the screen origin and fan out across the height of the display.
51-
52-
!!! note
53-
Graphics are not send to the OLED device when drawn. Updates are only sent to the device when the `display()` method is called. This minimizes data transfers to the OLED device, delivering a responsive display response.
54-
55-
```C++
56-
57-
myOLED.erase(); // Erase the screen
58-
myOLED.display(); // Send erase to device
59-
60-
delay(1000); // Slight pause
61-
62-
// Draw our lines from point (0,0) to (i, screen height)
63-
64-
for(int i=0; i < width; i+= 6){
65-
myOLED.line(0, 0, i, height-1); // draw the line
66-
myOLED.display(); // Send the new line to the device for display
67-
}
68-
```
69-
70-
71-
Library Provided Examples
72-
--------
73-
The SparkFun Qwiic OLED Arduino Library, includes a wide variety of examples. These are available from the Examples menu of the Arduino IDE, and in the [`examples`](https://github.com/sparkfun/SparkFun_Qwiic_OLED_Arduino_Library/blob/main/examples)folder of this repository.
74-
75-
For a detailed description of the examples, see the Examples section of the documentation.
7+
There are three ways to configure an RTK product:
768

9+
* [WiFi](https://learn.sparkfun.com/tutorials/sparkfun-rtk-facet-hookup-guide/all#system-configuration---wifi) - Good for in field changes
10+
* [Serial Terminal](https://learn.sparkfun.com/tutorials/sparkfun-rtk-facet-hookup-guide/all#system-configuration---serial-terminal) - Requires a computer but allows for all configuration settings
11+
* [Settings File](https://learn.sparkfun.com/tutorials/sparkfun-rtk-facet-hookup-guide/all#system-configuration---settings-file) - Error Prone; for very advanced users only.
7712

13+
The serial terminal method is recommended for most advanced configurations. Most, but not all settings are also available over WiFi but can be tricky to input via mobile phone.

0 commit comments

Comments
 (0)