Home automation

Thermostat

This repository contains a small typescript program that creates a software solution that acts as a thermostat. Given that we have some temperatures, we would like to know what the result is. The result can be used to control a heating and cooling unit.

Description

This project is about the temperature in a room, controled by domotica. If it's to hot, the thermostat should start cooling the room, if it's to cold, the thermostat should start cooling the room. To work without hardcoded temperatures, the project will fetch temperatures from the internet.

Development setup

At first, you need to install Visual Studio Code.

Then you need to install Typescript, either via npm (the Node.js package manager) by running the following command in your terminal:

npm install -g typescript

Or by installing TypeScript’s Visual Studio plugins.

To install the npm package, you can run the folllowing command:

npm i @tarikverschaetse/home-automation

Installation

You can clone the repository by running the following command in your terminal at the folder where you want this repository:

git clone [email protected]:vives-software-engineering-2020/home-automation-TarikVerschaetse.git

And to run the code on your own computer, you just run this command in your folder:

ts-node index.ts

Usage example

use jsonString to start with the thermostat:

jsonString = 
{ "temperature": 23.0, 
"range": 1.0, 
"unit": "celsius" }

result:

{"cooling":true,
"heating":false}

Meta

Tarik Verschaetse – [email protected]

Distributed under the MIT license. See LICENSE for more information.

https://github.com/vives-software-engineering-2020/home-automation-TarikVerschaetse

Contributing

1. Fork it (https://github.com/vives-software-engineering-2020/home-automation-TarikVerschaetse/fork)
2. Create your feature branch (git checkout -b vives-software-engineering-2020/home-automation-TarikVerschaetse)
3. Commit your changes (git commit -m 'fork home-automation')
4. Push to the branch (git push origin vives-software-engineering-2020/home-automation-TarikVerschaetse)
5. Create a new Pull Request

What doesn't work yet

• missing coverage
• generating docs doesn't work (npm ERR! code ELIFECYCLE)
• no more time to include tests