Home Assistant Omada Add-On

This add-on integrates the Omada Controller directly into Home Assistant, supporting both 64-bit ARM and x64 processors.

Add-On Versions

• Omada Stable: Built from the Omada Beta once updated to the latest stable upstream version.
• Omada Beta: Generally stable and based on the well-tested docker-omada-controller, but might contain minor Home Assistant-related inconsistencies or bugs.

Installation

To install this third-party add-on:

1. Open Home Assistant > Settings > Add-ons > Add-on Store.
2. Click the menu (three dots in the top-right corner) and select Repositories.
3. Paste the GitHub repository link into the field at the bottom:
   https://github.com/jkunczik/home-assistant-omada.
4. Refresh the page if needed. The add-on will appear under Home Assistant Omada.

Configuration Options

To use a custom SSL certificate configured for Home Assistant:

1. Enable Enable Home Assistant SSL in the add-on configuration.
2. Provide the full paths to the:
   1. Certificate file
   2. Private key
3. The default paths are compatible with the LetsEncrypt add-on.

Developing

For local development, use the Omada Dev variant. This is where the source code resides and where changes can be made. Follow the steps below to build and test a new Docker image:

Build the Docker Image Locally

Set the desired version and build the image:

# INSTALL_VER should match the version in the config.yaml
INSTALL_VER="5.14.32.4"
docker build . -t omada_stable --build-arg "INSTALL_VER=$INSTALL_VER"

Run the Docker Container Locally

docker run --rm -p 8043:8043 -v vol_omada_stable:/data omada_stable

Refer to the Home Assistant Add-On Testing Documentation for more details and best practices.

Releasing a New Version

1. Update the mbentley submodule to the latest master branch.
2. Update the version in config.yaml for either beta or stable. Ensure the version matches one listed in this script.
3. Thoroughly test the changes in a local environment. Once the tests pass and you're satisfied, create a pull request (PR) with the updates.
4. The pipeline will build docker images for every branch, but only push the images to the registry on master.

Contribution

This add-on wraps Matt Bentley’s docker-omada-controller, which is included as a Git submodule. Special thanks to DraTrav and contributors for advancing this project. This add-on was made possible thanks to their outstanding work.

Key differences from the original:

• Persistent data is stored in the /data directory, making it compatible with Home Assistant.

Contributions are welcome! Feel free to submit pull requests for version updates, bug fixes, or new features.

Made with contrib.rocks.