diff --git a/docs/content/1.home assistant/integration_setup.md b/docs/content/1.home assistant/integration_setup.md index d30d5e0..e8aac5e 100644 --- a/docs/content/1.home assistant/integration_setup.md +++ b/docs/content/1.home assistant/integration_setup.md @@ -8,48 +8,45 @@ WiCAN can be integrated with Home Assistant using the official integration. This ## Integration Device Setup - -image - - +![image](/ha/automate.png){width=300} To connect WiCAN to Home Assistant, you first need to connect it to the same WiFi network as Home Assistant. 1. **Connect to WiCAN Access Point**: Connect to the device's access point named **WiCAN\_xxxxxxx**. The default password is `@meatpi#`. It is recommended **to change the password** for safety reasons. -2. **Note the mDNS Name**: +1. **Note the mDNS Name**: In the **Status** tab, take note of the mDNS name. It should look something like `wican_xxxxxxxxxxxx.local`. `xxxxxxxxxxxx` is the device unique ID. -3. **Connect WiCAN to Home WiFi**: +1. **Connect WiCAN to Home WiFi**: Connect WiCAN to the same WiFi network as Home Assistant. In the WiCAN settings, change the **Mode** to **AP+Station**, and fill in your WiFi SSID and password. -4. **Change the Protocol**: +1. **Change the Protocol**: Set the **Protocol** to AutoPid. -5. **Submit and Reboot**: +1. **Submit and Reboot**: Click on the **Submit** button. The device will reboot on its own. -6. **Access WiCAN via mDNS**: +1. **Access WiCAN via mDNS**: Disconnect from the WiCAN access point, and using your web browser, go to the mDNS name you noted earlier, e.g., `wican_xxxxxxxxxxxx.local`. -7. **Enable Vehicle Specific Settings**: +1. **Enable Vehicle Specific Settings**: On the webpage, go to the **Automate** tab and enable **Vehicle Specific** settings. -8. **Sync Vehicle Model**: - Press the image button next to **Vehicle Model** to fetch supported vehicle models. +1. **Sync Vehicle Model**: + Press the ⟳ button next to **Vehicle Model** to fetch supported vehicle models. -9. **Select Vehicle Model**: +1. **Select Vehicle Model**: Select your vehicle model from the dropdown list. If your vehicle model is not yet supported, please open an issue on GitHub, and we will walk you through adding support. -10. **Set Cycle Time**: +1. **Set Cycle Time**: Set the **Cycle Time** in milliseconds. This defines how often WiCAN will request parameters from the ECU. -11. **Destination Topic** (optional): +1. **Destination Topic** (optional): This field is only used for MQTT communication. -12. **Store and Reboot**: +1. **Store and Reboot**: Click on the **Store** button, then go to the **About** tab to reboot the device. @@ -59,20 +56,23 @@ The WiCAN integration is available through HACS. You can find the integration re 1. **Install the Integration via HACS**: Add the integration repository link to HACS and install the **WiCAN** integration. + 1. Follow the official guide to [add a custom repository](https://www.hacs.xyz/docs/faq/custom_repositories/). The Repository URL is `https://github.com/jay-oswald/ha-wican` and it is an `Integration` + 1. Follow the official guide to [download a repository](https://www.hacs.xyz/docs/use/repositories/dashboard/#downloading-a-repository) + -2. **Navigate to Integrations**: +1. **Navigate to Integrations**: In Home Assistant, go to **Settings** > **Devices & Services** > **Integrations**. -3. **Add WiCAN Hub**: +1. **Add WiCAN Hub**: Click on **Add Integration**, search for **WiCAN**, and select it. -4. **Enter mDNS**: +1. **Enter mDNS**: Enter the mDNS name that you noted earlier (`wican_xxxxxxxxxxxx.local`) to connect the WiCAN device. After completing these steps, WiCAN will be connected to Home Assistant, and you will be able to monitor the available car parameters directly from the Home Assistant interface. -image +![example](/ha/example.png) diff --git a/docs/public/ha/automate.png b/docs/public/ha/automate.png new file mode 100644 index 0000000..89d3ec1 Binary files /dev/null and b/docs/public/ha/automate.png differ diff --git a/docs/public/ha/example.png b/docs/public/ha/example.png new file mode 100644 index 0000000..ad66ef5 Binary files /dev/null and b/docs/public/ha/example.png differ