|
1 | 1 | # Connecting Over WiFi |
2 | 2 |
|
3 | 3 |
|
4 | | -## Installation |
5 | | - |
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. |
| 4 | +Surveyor: Yes* / Express: Yes / Express Plus: Yes / Facet: Yes |
76 | 5 |
|
| 6 | +Starting with firmware v1.7, WiFi based configuration is supported. For more information about updating the firmware on your device, please see [Firmware Updates and Customization](https://learn.sparkfun.com/tutorials/sparkfun-rtk-facet-hookup-guide/all#firmware-updates-and-customization). |
77 | 7 |
|
| 8 | +The RTK device will present a webpage that is viewable from either a desktop/laptop with WiFi or a cell phone. For advanced configurations, a desktop is recommended. For quick in-field changes, a cell phone works great. |
| 9 | + |
| 10 | +-> [](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_Facet_-_Desktop_vs_Phone_Config.jpg) <- |
| 11 | + |
| 12 | +-> *Desktop vs Phone display size configuration* <- |
| 13 | + |
| 14 | +-> [](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_Facet_-_Display_WiFi_Config.jpg) <- |
| 15 | + |
| 16 | +-> *Device ready for cellphone configuration* <- |
| 17 | + |
| 18 | +To get into WiFi configuration follow these steps: |
| 19 | + |
| 20 | +1. Power on the RTK Facet. |
| 21 | +2. Once the device has started press the Setup button repeatedly until the *Config* menu is highlighted. |
| 22 | +3. The RTK Facet will blink a WiFi icon indicating it is waiting for incoming connections. |
| 23 | +4. Connect to WiFi network named ‘RTK Config’. |
| 24 | +5. Open a browser (Chrome is preferred) and type **192.168.4.1** into the address bar. |
| 25 | + |
| 26 | +-> [](https://cdn.sparkfun.com/assets/learn_tutorials/1/4/6/3/RTK_Surveyor_-_WiFi_Config_-_Networks.jpg) <- |
| 27 | + |
| 28 | +-> *The WiFi network RTK Config as seen from a cellphone* <- |
| 29 | + |
| 30 | +Note: Upon connecting, your phone may warn you that this WiFi network has no internet. That's ok. Stay connected to the network and open a browser. |
| 31 | + |
| 32 | +-> [](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_Facet_-_WiFi_Config_Main_Page.jpg) <- |
| 33 | + |
| 34 | +-> *Connected to the RTK WiFi Setup Page* <- |
| 35 | + |
| 36 | +Clicking on a category 'carrot' will open or close that section. Clicking on an ‘i’ will give you a brief description of the options within that section. |
| 37 | + |
| 38 | +-> [](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_Facet_-_WiFi_Config_Main_Page_-_Firmware.jpg) <- |
| 39 | + |
| 40 | +-> *This unit has firmware version 1.8 and a ZED-F9P receiver* <- |
| 41 | + |
| 42 | +Please note that the firmware for the RTK device and the firmware for the ZED receiver are shown at the top of the page. This can be helpful when troubleshooting or requesting new features. |
0 commit comments