Difference between revisions of "Documentation"

From OpenMotics
Jump to navigation Jump to search
 
(103 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== Command Line Interface (CLI) ==
+
== General ==
  
=== Commands ===
+
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.
;[[CLI Reference Guide]]
 
: The CLI Reference Guide describes all the available CLI commands that can be executed.
 
  
: The Gateway Module is the brains of the OpenMotics platform. It manages the other Modules on the bus and connects to the OpenMotics Cloud for online management and control over your installation
+
== Hardware Installation Guide ==
: Internally, the Gateway module houses 2 different computer systems:
 
# The Gateway controller: This Linux computer is a standard Beagle Bone Black that is fitted on the Master PCB
 
# The Master controller: This controller, that is fitted on the Master PCB, is based on a Microchip 18F67J11 that is programmed in PicBasic Pro. This Master PCB also has a real time clock with Battery, an Eeprom and the necessary communication channels (RS485, RS232).
 
  
: The Gateway module has multiple connections to the outside world: 2x RS485, 3xRS232 and Ethernet. The Ethernet, 1 RS485 and 2 serial connections are connected to the Gateway controller. 1 RS485 and 1 shared serial connection is connected to the Master controller. By setting jumpers, the shared serial connection will connect the Gateway controller with the Master controller over RS232. If needed and where appropriate, the shared serial connection can be used to access the Master controller directly over the built-in CLI interface (please see the CLI command reference interface for the different commands that exist). The CLI interface of the Master controller is also accessible through the Cloud interface (Maintenance mode tab).
+
* The OpenMotics modules can be easily installed without too much technical knowledge by using our
  
: The Master controller is connected to the gateway over RS232. An API and CLI on the Master controller is available and can be found back in this Wiki.
+
:[[Hardware Installation Guide]]
  
[[File:Gwoverview.png]]
+
* Detailed information about Hardware, schematics, PCB and other can be found in below section
  
=== Addenda ===
+
:[[Modules]]
;[[Error Codes]]
 
: All possible error codes returned by the [[Gateway Module]] [[CLI]].
 
  
;[[Action Types]]
+
* Is my heating system compatible with Openmotics?
: A detailed overview of the action type bytes in a [[Basic Action]].
 
  
;[[Config Types]]
+
:[[Heating Compatibility]]
: The config byte is used in [[Simple Action|Simple Actions]] and specifies the action to be performed.
 
  
;[[Decision Types]]
+
== Software Installation Guide ==
: The decision config byte are used in [[Basic Decision|Basic Decisions]] and define the “IF” statement condition.
+
The OpenMotics modules can be configured by using the Cloud software (graphical interface) or by using the CLI (text) interface for manual setup.  
  
;[[Output Debug Codes]]
+
=== Graphical user interface (Cloud) ===
: The debug codes used when Debug is active.
+
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]]
  
=== Setup Guides ===
+
=== CLI user interface (Cloud "Maintenance mode" or RS232) ===
;[[Thermostat Setup]]
+
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:
: A guide on setting up multiple thermostats
+
* 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]]
  
== Application programming interface (API) ==
+
== Master Controller Documentation ==
;[[OpenMotics Python SDK]]
 
  
;[[Gateway Module Webservice API|Webservice API]]
+
The technical firmware documentation (API, CLI, communication protocol etc) can be found here:
: The API available on the [[Gateway Module]]
 
  
;[[Gateway plugins]]
+
* 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 architecture]]
+
== 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]]
 +
:[[Gateway Module Webservice API|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]]
 +
* Information about connecting the P1 module can be found here
 +
:[[API Reference Guide P1]]
 +
* Information about Gateway network requirements for using the OM cloud can be found here
 +
:[[Gateway network requirements]]
 +
 
 +
== [[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.

Latest revision as of 14:24, 11 March 2021

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
  • Information about connecting the P1 module can be found here
API Reference Guide P1
  • Information about Gateway network requirements for using the OM cloud can be found here
Gateway network requirements

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.