https://github.com/sdwilsh/hass-truenas

TrueNAS integration for Home Assistant
https://github.com/sdwilsh/hass-truenas

freenas hacs home-assistant home-automation truenas

Last synced: about 2 months ago
JSON representation

TrueNAS integration for Home Assistant

• Host: GitHub
• URL: https://github.com/sdwilsh/hass-truenas
• Owner: sdwilsh
• License: mit
• Created: 2020-07-11T20:49:23.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-18T09:37:15.000Z (8 months ago)
• Last Synced: 2024-05-18T10:53:33.180Z (8 months ago)
• Topics: freenas, hacs, home-assistant, home-automation, truenas
• Language: Python
• Homepage:
• Size: 131 KB
• Stars: 36
• Watchers: 3
• Forks: 11
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![hacs_badge](https://img.shields.io/badge/HACS-Custom-orange.svg)](https://github.com/custom-components/hacs)

![hacs](https://github.com/sdwilsh/hass-truenas/workflows/hacs/badge.svg)

![hassfest](https://github.com/sdwilsh/hass-truenas/workflows/hassfest/badge.svg)

# TrueNAS Integration for Home Assistant

## Features

- Virtual machines and their running state

- Disks and their temperature

## Installation

1. Install using [HACS](https://github.com/custom-components/hacs). Or install manually by copying `custom_components/truenas` folder into `/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

```