mk-home-server is build to offer the smarthome functionality of a device as a REST interface. In detail it is used to run on a server, like a raspberry pi, where several smarthome device are connected to. In particular for now the IKEA Tradfri gateway is supported, as well as a instance of netdata to monitor the system used underneath.
This project is still in an early development state and for now is somehow specified to the setup I using in my structure. Nevertheless you can easily utilize it to make it work with your setup or rebuild the environment I am using to make it work.
Run the project
The mk-home-server REST API is designed to either run by the pm2 process manager or in a docker container for production purposes.
The according settings for this can be found in the
To start it with pm2 you can use:
pm2 start ecosystem.config.yml
To save this setting over the next system startup and make it run permanently use:
To start the API and the according MariaDB database you can easily do:
docker-compose up -d --build
If you just want to develop or test the current implementation you can also run the following commands to run the API in your systems node environment and with hot reloading maintained by
yarn install yarn dev # If you also want to use the database you can run the instance inside of docker with: docker-compose up -d --build db # optional
UI to use the provided data
According to this server implementation there is also a UI which is using the offered functionality of this project to control specific devices with a Web App and make it accessible to all devices in the local network. It is called mk-home and can be found here.