Skip to content

eclipseron/homeassistant-hyperbase

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Hyperbase Integration for Home Assistant

Integration component for Hyperbase local IoT data center system. Perform Iot devices data collecting without complex database configurations.

🔧 Installation

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

  1. Open HACS in Home Assistant
  2. Find "Custom repositories" in the option
  3. Enter https://github.com/eclipseron/homeassistant-hyperbase.git. Choose "Integration" for the Type input.
  4. Click Add.
  5. Search for "Hyperbase" in HACS. Press Download and restart your HA.
  6. Go to Settings > Devices & services > + Add integration.
  7. Find "Hyperbase" and start the integration setup.

⚙️ Initial Setup

1️⃣ Hyperbase Setup

You can follow Hyperbase installation guide from documentation to create your Hyperbase instance. Once the installation ready, create new Hyperbase admin account and login. Now, you can create a new Project.

  1. Inside the new project, you can find a "User" collection that is already created. Select the "User" collection and Insert a record.

onboarding-1

  1. Enter a username and password to identify the owner of each records. You can use your Home Assistant account or create new one. This user record be used to authorize MQTT publish from HA. Hit the save button when you are done.

onboarding-3

  1. You can find three-dots icon options-icon on the right side of the "User" collection. Click it and choose Edit.

onboarding-3

  1. Check the Using the _id field to authenticate MQTT publishers option then press Edit.

onboarding-4

2️⃣ Create New Hyperbase Integration

  1. On the Home Assistant web UI, go to Settings > Devices & services > Add integration. Search for "Hyperbase" and select the integration.

onboarding-5

  1. Fill all required fields with your Hyperbase configuration. Press Submit to continue.

Hyperbase Base URL is not URL of the Hyperbase UI but Hyperbase server.

onboarding-7

  1. Enter your Hyperbase administrator credentials into email and password fields. Hyperbase Project ID and Home Assistant User ID can be found here:

onboarding-8

  1. Press Submit and wait for the start up process. You can access Hyperbase integration service by clicking the card on Integrations page (Settings > Devices & services).

onboarding-9

✏️ Features

  • Connected with Hyperbase: Configure Hyperbase connection through UI without coding needed.
  • Full Control Over Your Data: Choose what information you need to store, change whenever you want.
  • Regular Consistency Check: Regularly check connection between HA and Hyperbase. Data collecting failures handled with no worries.

📖 Documentation

Hyperbase Documentation: https://github.com/HyperbaseApp/hyperbase

Hyperbase for HA Documentation: https://eclipseron.github.io/homeassistant-hyperbase

About

Hyperbase integration to Home Assistant. Automate device integration registration, device platform collection schema builder, and data collecting. https://github.com/HyperbaseApp/hyperbase

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages