The Open Source Controller
image::extra/images/logo-mycontroller.org_full.png[MyController.org, link="http://www.mycontroller.org"] :source-language: java, angularjs
ifdef::env-github image:https://badges.gitter.im/Join%20Chat.svg[link="https://gitter.im/mycontroller-org/mycontroller?utmsource=badge&utmmedium=badge&utmcampaign=pr-badge&utmcontent=badge"] endif::
[link=https://travis-ci.org/mycontroller-org/mycontroller] Master: image:https://travis-ci.org/mycontroller-org/mycontroller.svg?branch=master["Build Status", link="https://travis-ci.org/mycontroller-org/mycontroller"] [link=https://travis-ci.org/mycontroller-org/mycontroller] Development: image:https://travis-ci.org/mycontroller-org/mycontroller.svg?branch=development["Build Status", link="https://travis-ci.org/mycontroller-org/mycontroller"]
====== Project website: http://www.mycontroller.org ====== Forum: http://forum.mycontroller.org ====== Want to try now? http://demo.mycontroller.org[Demo server] Authentication: demo/demo
MyController.org is an IoT automation controller for home, office or any place. Primarly this project was started to support http://www.mysensors.org/[MySensors]. Later it was expanded to support other networks also. MyController.org was designed to run with limited resources. For instance, it can run on the first generation Raspberry Pi.
== Localization MyController.org supports multiple languages. If you are interested in providing a translation for your native language, send a request via https://www.transifex.com/mycontrollerorg/multi-locale/[Transifex MyController.org locale project]
== System Requirements
MyController.org is a very lightweight server. Its resource requirements are modest:
===== Supported Platforms (tested) MyController.org is a Java-based application server. It can run on any platform where Java support is available.
== MyController and MySensors Setup
image::extra/images/MyController-MySensors-RF.png[MyController and MySensors setup.]
====== Download(executable bundle),
Extract the downloaded bundle in the directory where you want it to run. The configuration files are located in
<1> You can change the default location and file name. This directory is used as a temporary location for operations such as backup, restore, etc.
<1> You can change the default location and file name. The database file will be stored with the extension
.h2.db. Do not add file extension to this property.
mcc.web.bind.address=0.0.0.0 # <1> mcc.web.enable.https=true # <2> mcc.web.http.port=8443 # <3> mcc.web.file.location=../www/ # <4> mcc.web.ssl.keystore.file=../conf/keystore.jks # <5> mcc.web.ssl.keystore.password=mycontroller # <5>
<1> Bind interface address. 0.0.0.0 means it will bind to all available interfaces. <2> Enable/disable https. Only one protocol is supported at a time. true -
https, false -
http. <3> Port number of
http/httpsto access MyController.org server. <4> Web files location, no need to touch this one. <5> If
httpsis enabled these fields are mandatory.
NOTE: Default username/password:
Important: Change default
httpsprotocol is recommended
mcc.mqtt.broker.enable=true # <1> mcc.mqtt.broker.bind.address=0.0.0.0 # <2> mcc.mqtt.broker.port=1883 # <3> mcc.mqtt.broker.websocket.port=7080 # <4>
<1> Enable/disable builtin MQTT broker. By default it is enabled.
false- disabled <2> Bind interface address for the MQTT broker. By default it will bind to all available interfaces. <3> MQTT broker port <4> Websoicket port <5> Internal use. no need to touch this one.
Configuration File Name:
Default log file location:
====== Start/Stop Server Executable scripts are located in
java -Xms8m -Xmx256m -Dlogback.configurationFile=../conf/logback.xml -Dmc.conf.file=../conf/mycontroller.properties -cp "../lib/*" org.mycontroller.standalone.StartApp