Documentation Landing Page

Introduction

MisterHouse is an open source home automation program, written in Perl, it controls devices based on time, web, socket, voice, and serial data. It currently runs on Windows 95/98/NT/2k/XP/10 and on most Unix based platforms, including Linux, Ubuntu, Raspian and Mac OSX. It has a very small footprint and has been implemented on devices as small as a Raspberry PI. MisterHouse has a Web interface 'out of the box', but has been created to be easily extended and modified by adding Perl code. MisterHouse has a very active support community who have created interfaces for a very large number of supported protocols and interfaces

News

• We have added new pages on Resilience, Design Ideas, Tasmota
• WIP documents on the new Logging sub system

Getting started with MisterHouse

• MisterHouse Overview
• Installation
• Configuration
• Adding devices
• Accessing the web pages
• Resilience
• Examples
• Developer help
• Design Ideas
• FAQ

Extending MisterHouse

Functionality can be added to the core of MisterHouse by adding perl scripts which are 'eval'd at startup time. MisterHouse can be interfaced to other systems by using the web interface.

MisterHouse Documentation

• The MisterHouse core and Startup options
• Supported hardware interfaces
• Global variables
• Items and their methods
• The .mht file
• Functions
• TK widget functions
• Trigger functions
• Internet functions
• Companion programs
• Authentication
• Customising the Menu interfaces
• Customising the Tk Interface
• Customising the Web Interface
• Voice Recognition (VR) and Text To Speech (TTS)
• Hooks and noloop
• Distributed proxies
• Best practice, hints and tips

Links

Click here for articles and websites about MisterHouse.

Contributing

This is a volunteer project, no money is collected, raised, or paid for any work contributed to this project. In order to survive, MisterHouse relies on the generosity of its users. Please see here for the project governance.

If you use MisterHouse, please consider paying for it by contributing some of your time to MisterHouse. We realise that not everyone is capable of writing software code, but nearly everyone is capable of contributing user documentation.

So please if you see a mistake or you discover a problem/solution that is not documented here, please let us know.

Licensing

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.