/hacs-vestaboard

Home Assistant integration for Vestaboard messaging displays.

Primary LanguagePythonMIT LicenseMIT

Release Buy Me A Coffee/Beer hacs_badge

Vestaboard logo

Vestaboard for Home Assistant

Home Assistant integration for Vestaboard messaging displays.

Installation

There are two main ways to install this custom component within your Home Assistant instance:

  1. Using HACS (see https://hacs.xyz/ for installation instructions if you do not already have it installed):

    Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.

    1. Use the convenient My Home Assistant link above, or, from within Home Assistant, click on the link to HACS
    2. Click on Integrations
    3. Click on the vertical ellipsis in the top right and select Custom repositories
    4. Enter the URL for this repository in the section that says Add custom repository URL and select Integration in the Category dropdown list
    5. Click the ADD button
    6. Close the Custom repositories window
    7. You should now be able to see the Vestaboard card on the HACS Integrations page. Click on INSTALL and proceed with the installation instructions.
    8. Restart your Home Assistant instance and then proceed to the Configuration section below.

  2. Manual Installation:

    1. Download or clone this repository
    2. Copy the contents of the folder custom_components/vestaboard into the same file structure on your Home Assistant instance
      • An easy way to do this is using the Samba add-on, but feel free to do so however you want
    3. Restart your Home Assistant instance and then proceed to the Configuration section below.

While the manual installation above seems like less steps, it's important to note that you will not be able to see updates to this custom component unless you are subscribed to the watch list. You will then have to repeat each step in the process. By using HACS, you'll be able to see that an update is available and easily update the custom component.

Configuration

Open your Home Assistant instance and start setting up a new integration.

There is a config flow for this Vestaboard integration. After installing the custom component, use the convenient My Home Assistant link above.

Alternatively:

  1. Go to Configuration->Integrations
  2. Click + ADD INTEGRATION to setup a new integration
  3. Search for Vestaboard and click on it
  4. You will be guided through the rest of the setup process via the config flow

Options

After this integration is set up, you can configure the model of your Vestaboard to adjust the image that is generated.

Models:

  • Flagship Black Flagship Black Connected
  • Vestaboard White Vestaboard White Connected

Support Me

I'm not employed by Vestaboard, and provide this custom component purely for your own enjoyment and home automation needs.

If you don't already own a Vestaboard, please consider using my referal link below to get $200 off (as well as a $200 referral bonus to me in appreciation)!

https://shop.vestaboard.com/?vbref=ZWVLZW

If you already own a Vestaboard and still want to donate, consider sponsoring me on GitHub or buying me a coffee ☕ (or beer 🍺) instead by using the link below:

Buy Me a Coffee at ko-fi.com