https://github.com/voxpupuli/puppet-homeassistant

Puppet Module for Home Assistant - home automation platform. https://home-assistant.io/
https://github.com/voxpupuli/puppet-homeassistant

centos-puppet-module debian-puppet-module hacktoberfest linux-puppet-module oraclelinux-puppet-module puppet redhat-puppet-module scientific-puppet-module ubuntu-puppet-module

Last synced: 15 days ago
JSON representation

Puppet Module for Home Assistant - home automation platform. https://home-assistant.io/

• Host: GitHub
• URL: https://github.com/voxpupuli/puppet-homeassistant
• Owner: voxpupuli
• License: apache-2.0
• Created: 2017-02-15T19:39:20.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-09-17T07:36:05.000Z (4 months ago)
• Last Synced: 2024-10-29T14:22:36.588Z (2 months ago)
• Topics: centos-puppet-module, debian-puppet-module, hacktoberfest, linux-puppet-module, oraclelinux-puppet-module, puppet, redhat-puppet-module, scientific-puppet-module, ubuntu-puppet-module
• Language: Ruby
• Size: 161 KB
• Stars: 8
• Watchers: 39
• Forks: 9
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Puppet module for Home Assistant

[![Build Status](https://travis-ci.org/voxpupuli/puppet-homeassistant.png?branch=master)](https://travis-ci.org/voxpupuli/puppet-homeassistant)

[![Code Coverage](https://coveralls.io/repos/github/voxpupuli/puppet-homeassistant/badge.svg?branch=master)](https://coveralls.io/github/voxpupuli/puppet-homeassistant)

[![Puppet Forge](https://img.shields.io/puppetforge/v/puppet/homeassistant.svg)](https://forge.puppetlabs.com/puppet/homeassistant)

[![Puppet Forge - downloads](https://img.shields.io/puppetforge/dt/puppet/homeassistant.svg)](https://forge.puppetlabs.com/puppet/homeassistant)

[![Puppet Forge - endorsement](https://img.shields.io/puppetforge/e/puppet/homeassistant.svg)](https://forge.puppetlabs.com/puppet/homeassistant)

[![Puppet Forge - scores](https://img.shields.io/puppetforge/f/puppet/homeassistant.svg)](https://forge.puppetlabs.com/puppet/homeassistant)

## 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

```puppet

include homeassistant

```

or with a custom configuration.

```puppet

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.

```puppet

homeassistant::component{

  [

    'config',

    'http',

    'frontend',

    'updater',

    'discovery',

    'conversation',

    'history',

    'sun',

    'logbook',

  ]:

}

```

Components with configuration.

```puppet

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

```puppet

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.