sdwilsh / hass-truenas

TrueNAS integration for Home Assistant
MIT License
39 stars 11 forks source link
freenas hacs home-assistant home-automation truenas

hacs_badge hacs hassfest

TrueNAS Integration for Home Assistant

Features

Installation

  1. Install using HACS. Or install manually by copying custom_components/truenas folder into <config_dir>/custom_components
  2. Restart Home Assistant.
  3. In the Home Assistant UI, navigate to Configuration then Integrations. Click on the add integration button at the bottom right and select TrueNAS. Fill out the options and save.
    • Host: the ip address or hostname of the TrueNAS server.
    • Username: the username used to login to the TrueNAS server.
    • Password: the password used to login to the TrueNAS server.

Using Services

truenas.jail_start

truenas.jail_stop

truenas.jail_restart

truenas.vm_start

truenas.vm_stop

truenas.vm_restart

Development

python3.9 -m venv .venv
source .venv/bin/activate

# Install Dev Requirements
pip install -r requirements-dev.txt

# One-Time Install of Commit Hooks
pre-commit install

# Run tests
python -m pytest tests