Forge Home

homeassistant

Configures Home Assistant - home automation platform. https://home-assistant.io/

9,273 downloads

1,439 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 1.0.0 (latest)
  • 0.2.2
  • 0.2.1
  • 0.2.0
  • 0.1.3
  • 0.1.2
  • 0.1.1
  • 0.1.0
released Nov 7th 2020
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x
  • Puppet >= 5.5.8 < 7.0.0
  • , , , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'puppet-homeassistant', '1.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppet-homeassistant
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppet-homeassistant --version 1.0.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

puppet/homeassistant — version 1.0.0 Nov 7th 2020

Puppet module for Home Assistant

Build Status Code Coverage Puppet Forge Puppet Forge - downloads Puppet Forge - endorsement Puppet Forge - scores

Description

Home Assistant is an open-source home automation platform running on Python 3. This puppet module can be used to install and configurue Home Assistant. Home assistant is installed within an python3 virtualenv environment.

Home Assistant - https://home-assistant.io/

Usage

To install and start homeassistant

include ::homeassistant

or with a custom configuration.

class{'::homeassistant':
    location_name => 'Arc de Triomphe',
    latitude      => 48.8738,
    longitude     => 2.2950,
    elevation     => 300,
    unit_system   => 'metric',
    time_zone     => 'Europe/Paris'
}

Parameters for homeassistant class

  • user - Specify a username to run the service as. Default: homeassistant
  • home - Home directory of user and virtualeven for software. Default: /srv/homeassistant
  • ...

Adding Components

Simple components with no configuration.

homeassistant::component{
  [
    'config',
    'http',
    'frontend',
    'updater',
    'discovery',
    'conversation',
    'history',
    'sun',
    'logbook',
  ]:
}

Components with configuration.

homeassistant::component{'tts':
  config => {'platform' => 'google'}
}

homeassistant::component{'device_tracker':
  config => [
    {'platform' => 'netgear',
     'host'     => 'router.example.org',
     'username' => 'admin',
     'password' => 'secret',
    }
  ],
}

Multiple Instances of one Component, e.g. Switches

homeassistant::component{'myswitchs':
  component => 'switch',
  config    => [
                 {'platform' => 'google',
                 },
                 {'platform' => 'tplink',
                  'host'     => 'myplug.example.org',
                  'username' => 'foo',
                  'password' => 'bar',
                 },
               ],
  }
}
homeassistant::component{'otherswitches':
  component => 'switch',
  config    => {
    platform => 'command_line',
    switches => {
                  'command_on'    => '/bin/echo on > /tmp/hi',
                  'command_off'   => '/bin/ehco off > /tmp/hi',
                  'command_state' => '/bin/grep -q on /tmp/hi',
                  'friendly_name' => 'Is the file on',
                }
    }
  }
}

Authors

puppet-homeassistant is maintained by VoxPupuli. It was originally written by Steve Traylen.