Documentation

From OpenMotics
Jump to: navigation, search

General

Please read the Gateway Introduction so you understand the interaction between the different computer boards in the Gateway. You should first read this before using the below documentation.

Hardware Installation Guide

  • The OpenMotics modules can be easily installed without too much technical knowledge by using our
Hardware Installation Guide
  • Detailed information about Hardware, schematics, PCB and other can be found in below section
Modules
  • Is my heating system compatible with Openmotics?
Heating Compatibility

Software Installation Guide

The OpenMotics modules can be configured by using the Cloud software (graphical interface) or by using the CLI (text) interface for manual setup.

Graphical user interface (Cloud)

Following Graphical user interface manual is available:

  • For full system setup using the Cloud Interface, see
System cloud setup
  • For detailed switch setup and how to assign more functions to 1 switch, see
Switch Setup

CLI user interface (Cloud "Maintenance mode" or RS232)

The below setup guides will explain the full programming of the Master Controller by using the CLI interface. It is however possible to install and configure the full OpenMotics system through the graphical cloud interface without using the CLI. Following CLI guides are available for manual setup:

  • To see all available RS232 CLI instructions, please consult
CLI Reference Guide
  • To add/change/remove modules and enable Large Installation mode using CLI mode, see
Module Change
  • For basic system setup (add modules, assign inputs to outputs, set timers etc) using the CLI interface, see
CLI Basic System Setup
  • For thermostat setup using the CLI interface, see
CLI Thermostat Setup
  • For advanced thermostat setup, Heating and cooling including Daikin setup using the CLI interface, see
Daikin Setup
  • For advanced system setup using the CLI interface, see
CLI Advanced Setup

Master Controller Documentation

The technical firmware documentation (API, CLI, communication protocol etc) can be found here:

  • To see all available RS232 CLI instructions, please consult
CLI Reference Guide
  • To understand the different Basic Actions available in the Master, please consult the
Action Types (List of Basic Actions)
  • To understand the different debug codes in CLI mode, please consult
Output Debug Codes
  • To understand the Error Codes appearing in CLI mode, please consult the
Error Codes
  • To understand the Memory model used in the eeprom of the Master controller, please consult the
Memory Model
  • To see all available RS232 API instructions, please consult
API Reference Guide
  • To understand the RS485 communication protocol, please consult
Master RS485 Cummunication Protocol
  • To understand how to use the CAN modules, please consult
CAN Control Installation
  • To see the changes in the Master firmware, please consult
Master Release Notes
  • To see the changes in the CAN Controller firmware, please consult
CAN Controller Release Notes

Gateway Controller Documentation

  • Description of the Gateway architecture can be found here
Gateway architecture
  • The API instruction houses all Gateway controller instructions as well as all all Master controller instructions. This API can be found here
OpenMotics Python SDK
Webservice API
  • The Gateway controller has a plug-in systems that can be found here
Gateway plugins
  • Information about installing the Gateway can be found here
Gateway installation

Open Source

OpenMotics want to be a fully Opensource product and we're in the process of publishing the sources. More info at our Open Source page.