From 0037883bf351d8a830f7373e7a4e21ef4621a682 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcel=20St=C3=B6r?= Date: Fri, 22 May 2020 08:57:39 +0200 Subject: [PATCH 1/2] Convert README to Markdown --- Readme.txt => README.md | 99 +++++++++++++++++++---------------------- 1 file changed, 47 insertions(+), 52 deletions(-) rename Readme.txt => README.md (60%) diff --git a/Readme.txt b/README.md similarity index 60% rename from Readme.txt rename to README.md index 746ac152..516f2b65 100755 --- a/Readme.txt +++ b/README.md @@ -1,4 +1,4 @@ -RaspiWiFi +# RaspiWiFi RaspiWiFi is a program to headlessly configure a Raspberry Pi's WiFi connection using using any other WiFi-enabled device (much like the way @@ -15,9 +15,9 @@ tested with the Raspberry Pi B+, Raspberry Pi 3, and Raspberry Pi Zero W. -OS IMAGE USAGE: +## OS Image Usage -== Just burn the ".IMG" file attached to this release to an 8GB+ SD card. Boot +Just burn the ".IMG" file attached to this release to an 8GB+ SD card. Boot your Raspberry Pi with the SD card and it will automatically boot into its AP Host (broadcast) mode with an SSID based on a unique id (the last four of your Pi's serial number). No input devices or displays necessary. Otherwise this is @@ -26,49 +26,48 @@ this release. - SCRIPT-BASED INSTALLATION INSTRUCTIONS: +## Script-based Installation Instructions +Navigate to the directory where you downloaded or cloned RaspiWiFi -== Navigate to the directory where you downloaded or cloned RaspiWiFi +Run: +``` +sudo python3 initial_setup.py +``` -== Run: - -sudo python3 initial_setup.py - -== This script will install all necessary prerequisites and copy all necessary +This script will install all necessary prerequisites and copy all necessary config and library files, then reboot. When it finishes booting it should present itself in "Configuration Mode" as a WiFi access point with the name "RaspiWiFi[xxxx] Setup". -== The original RaspiWiFi directory that you ran the Initial Setup is no longer +The original RaspiWiFi directory that you ran the Initial Setup is no longer needed after installation and can be safely deleted. All necessary files are -copied to /usr/lib/raspiwifi/ on setup. - +copied to `/usr/lib/raspiwifi/` on setup. -CONFIGURATION: -== You will be prompted to set a few variables during the Initial Setup script: +## Configuration +You will be prompted to set a few variables during the Initial Setup script: -==== "SSID Prefix" [default: "RaspiWiFi Setup"]: This is the prefix of the SSID +- **SSID Prefix** [default: "RaspiWiFi Setup"]: This is the prefix of the SSID that your Pi will broadcast for you to connect to during Configuration Mode (Host Mode). The last four of you Pi's serial number will be appended to whatever you enter here. -==== "WPA Encryption" [default: No]: If oyu enable this setting the Access Point +- **WPA Encryption** [default: No]: If oyu enable this setting the Access Point created during Configuration Mode will be encrypted using WPA2 encryption. The prompt following this one will let you specify the Wireless Key to be used. You can leave the password blank if you chose 'N' to this option. -==== "Auto-Config mode" [default: n]: If you choose to enable this mode your Pi +- **Auto-Config mode** [default: n]: If you choose to enable this mode your Pi will check for an active connection while in normal operation mode (Client Mode). If an active connection has been determined to be lost, the Pi will reboot back into Configuration Mode (Host Mode) automatically. -==== "Auto-Config delay" [default: 300 seconds]: This is the time in consecutive +- **Auto-Config delay** [default: 300 seconds]: This is the time in consecutive seconds to wait with an inactive connection before triggering a reset into Configuration Mode (Host Mode). This is only applicable if the "Auto-Config mode" mentioned above is set to active. -==== "Server port" [default: 80]: This is the server port that the web server +- **Server port** [default: 80]: This is the server port that the web server hosting the Configuration App page will be listening on. If you change this port make sure to add it to the end of the address when you're connecting to it. For example, if you speficiy 12345 as the port number @@ -76,67 +75,63 @@ CONFIGURATION: leave the port at the default setting [80] there is no need to specify the port when navigating to the page. -==== "SSL Mode" [default: n]: With this option enabled your RaspiWifi +- **SSL Mode** [default: n]: With this option enabled your RaspiWifi configuration page will be sent over an SSL encrypted connection (don't forget the "s" when navigating to https://10.0.0.1:9191 when using this mode). You will get a certificate error from your web browser when connecting. The error is just a warning that the certificate has not been verified by a third party but everything will be properly encrypted anyway. + +All of these variables can be set at any time after the Initial Setup has +been running by editing the `/etc/raspiwifi/raspiwifi.conf` -== All of these variables can be set at any time after the Initial Setup has -been running by editing the /etc/raspiwifi/raspiwifi.conf +## Usage -USAGE: - -== Connect to the "RaspiWiFi[xxxx] Setup" access point using any other WiFi enabled +- Connect to the "RaspiWiFi[xxxx] Setup" access point using any other WiFi enabled device. - -== Navigate to [10.0.0.1], [raspiwifisetup.com], or -[idliketoconfigurethewifionthisdevicenowplease.com] (I was debating whether this +- Navigate to [http://10.0.0.1](), [http://raspiwifisetup.com](), or +[http://idliketoconfigurethewifionthisdevicenowplease.com]() (I was debating whether this was funny or not and, yes, it was) using any web browser on the device you -connected with. (don't forget to manually start with [https://] when using SSL mode) - -== Select the WiFi connection you'd like your Raspberry Pi to connect to from +connected with. Don't forget to manually start with `https://` when using SSL mode. +- Select the WiFi connection you'd like your Raspberry Pi to connect to from the drop down list and enter its wireless password on the page provided. If no encryption is enabled, leave the password box blank. You may also manually specify your network information by clicking on the "manual SSID entry ->" link. - -== Click the "Connect" button. - -== At this point your Raspberry Pi will reboot and connect to the access point +- Click the "Connect" button. +- At this point your Raspberry Pi will reboot and connect to the access point specified. - -== You can view the current WPA encryption settings and change them from the main Web +- You can view the current WPA encryption settings and change them from the main Web Configuration interface. The current settings are visible in a panel in the upper left corner of the screen. If you click the values in this display you will be taken to a page where you can change them. If you change them your device will reboot to enable the new configuration. - -== You can also use the Pi in a point-to-point connection mode by leaving it in -Configuration Mode. All services will be addresible in their normal way at +- You can also use the Pi in a point-to-point connection mode by leaving it in +Configuration Mode. All services will be addressible in their normal way at 10.0.0.1 while connected to the "RaspiWiFi[xxxx] Setup" AP. -RESETTING THE DEVICE: +## Resetting The Device -== If GPIO 18 is pulled HIGH for 10 seconds or more the Raspberry Pi will reset +If GPIO 18 is pulled HIGH for 10 seconds or more the Raspberry Pi will reset all settings, reboot, and enter "Configuration Mode" again. It's useful to have a simple button wired on GPIO 18 to reset easily if moving to a new location, or if incorrect connection information is ever entered. Just press and hold for 10 seconds or longer. -== You can also reset the device by running the manual_reset.py in the -/usr/lib/raspiwifi/reset_device directory as root or with sudo. +You can also reset the device by running the `manual_reset.py` in the +`/usr/lib/raspiwifi/reset_device` directory as root or with sudo. -UNINSTALLATION: +## Uninstallation -== You can uninstall RaspiWiFi at any time by running: - - sudo python3 /usr/lib/raspiwifi/uninstall.python3 +You can uninstall RaspiWiFi at any time by running: + +``` +sudo python3 /usr/lib/raspiwifi/uninstall.python3 +``` - You can also run it from the "libs/" directory from a fresh clone if you've - installed from a previous version and don't have /usr/lib/raspiwifi/uninstall.py - available. \ No newline at end of file +You can also run it from the "libs/" directory from a fresh clone if you've +installed from a previous version and don't have `/usr/lib/raspiwifi/uninstall.py` +available. \ No newline at end of file From 90195313a792822050c9976ad998c9ce72ce7090 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcel=20St=C3=B6r?= Date: Mon, 1 Jun 2020 17:38:54 +0200 Subject: [PATCH 2/2] Fix uninstall command --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 516f2b65..46d294c8 100755 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ Navigate to the directory where you downloaded or cloned RaspiWiFi Run: ``` -sudo python3 initial_setup.py +sudo python3 initial_setup.py ``` This script will install all necessary prerequisites and copy all necessary @@ -81,7 +81,7 @@ You will be prompted to set a few variables during the Initial Setup script: this mode). You will get a certificate error from your web browser when connecting. The error is just a warning that the certificate has not been verified by a third party but everything will be properly encrypted anyway. - + All of these variables can be set at any time after the Initial Setup has been running by editing the `/etc/raspiwifi/raspiwifi.conf` @@ -127,11 +127,11 @@ You can also reset the device by running the `manual_reset.py` in the ## Uninstallation You can uninstall RaspiWiFi at any time by running: - + ``` -sudo python3 /usr/lib/raspiwifi/uninstall.python3 +sudo python3 /usr/lib/raspiwifi/uninstall.py ``` You can also run it from the "libs/" directory from a fresh clone if you've installed from a previous version and don't have `/usr/lib/raspiwifi/uninstall.py` -available. \ No newline at end of file +available.