Browse Source

Update the documentation to consider the AP mode

Tomi 2 years ago
parent
commit
7c024524f4
1 changed files with 11 additions and 12 deletions
  1. 11
    12
      README.md

+ 11
- 12
README.md View File

@@ -25,15 +25,16 @@ Then modifiy your project's CMakeLists.txt to include the `picowota` directory:
25 25
 add_subdirectory(picowota)
26 26
 ```
27 27
 
28
-`picowota` (currently) connects to an existing WiFi network, so you need to
29
-set the SSID and password for the network to connect to.
28
+`picowota` either connects to an existing WiFi network (by default) or
29
+creates one, in both cases with the given SSID and password.
30 30
 
31
-You can either export the `PICOWOTA_WIFI_SSID` and `PICOWOTA_WIFI_PASS`
32
-environment variables, or set the CMake variables with the same name:
31
+You can either provide the following as environment variables, or set them
32
+as CMake variables:
33 33
 
34 34
 ```
35
-set(PICOWOTA_WIFI_SSID MyNetworkName)
36
-set(PICOWOTA_WIFI_PASS MyPassw0rd)
35
+PICOWOTA_WIFI_SSID # The WiFi network SSID
36
+PICOWOTA_WIFI_PASS # The WiFi network password
37
+PICOWOTA_WIFI_AP # Optional; 0 = connect to the network, 1 = create it
37 38
 ```
38 39
 
39 40
 Then, you can either build just your standalone app binary (suitable for
@@ -90,6 +91,10 @@ As long as the Pico is "in" the `picowota` bootloader (i.e. because there's no
90 91
 valid app code uploaded yet, or your app called `picowota_reboot(true);`), you
91 92
 can upload an app `.elf` file which was built by `picowota_build_standalone()`:
92 93
 
94
+If using the AP mode, the Pico's IP address will be (at the time of writing)
95
+192.168.4.1/24, and the connected device's something in the same subnet.
96
+Otherwise it depends on your network settings.
97
+
93 98
 (Assuming your Pico's IP address is 192.168.1.123):
94 99
 ```
95 100
 serial-flash tcp:192.168.1.123:4242 my_executable_name.elf
@@ -122,9 +127,3 @@ It would be nice to be able to avoid this duplication, but the Pico SDK
122 127
 libraries don't give a mechanism to do so.
123 128
 
124 129
 I've raised https://github.com/raspberrypi/pico-sdk/issues/928 for consideration.
125
-
126
-### Expose an access point, rather than connecting to one
127
-
128
-It would perhaps be better if the bootloader set up an access point, rather than
129
-trying to connect to an existing network - or even better, provide the option.
130
-I expect that wouldn't be too hard to do.

Loading…
Cancel
Save