search

chkr1011 / Wirehome.Core

Wirehome.Core is a home automation system written in C# targeting .NET Core. It runs on Linux, Windows and macOS.
Apache License 2.0
255 stars 63 forks source link

install #2

Open mkrumov opened 6 years ago

mkrumov commented 6 years ago

Hi, can you explain the installation in detail - I mean haw to add repository, how to set up json config files. I started successfully Wirehome.Core on raspberry, but don't know how to add repository.

Regards, Mario

chkr1011 commented 6 years ago

Hi, sorry for not having this done yet. This is urgent I know 😄

So to make it quick (referring to latest master-branch):

After setting up the Raspberry as described in the Wiki you have to "install" all "plugins" you need. They are also pushed to GitHub (https://github.com/chkr1011/Wirehome.Repository).

This source for repository entities is the default in Wirehome.Core. What you actually need depends on the hardware you use. But you can also download everything if you want. To download such a plugin please open the swagger endpoint ("/swagger/"). There you will find the "Repository" area which provides a "/api/v1/repository/{uid}/download" method. This method will download the specified entity (UID) to your local installation (directly from GitHub). For a list of UIDs please have a look at the GitHub repo (root path).

So if you want to setup e.g. the OpenWeatherMap service you have to download "service.wirehome.open_weather_map_importer@1.0.0" where "1.0.0" is the actual version of the service. You can have a look at the release notes for every entity.

After this has succeeded you have to create a config in order to start this service. The required configuration parameters are usually documented in the Description.md of every entity. So calling /api/v1/repository/{uid}/description will show you more details for the specified entity (don't forget the ...@1.0.0 version tag).

After you build the JSON config with your editor of choice you can upload it using the API /api/v1/services/{id}/initialize_. The config JSON must be sent as the Body (I recommend Postman for HTTP API calls).

If your service is configured properly you will see the values in the Web App at the top.

Please let me know if this works for you. If it does, I will explain the next steps in order to setup a device/component etc.

You can also have a look at /docs/exampleConfiguration. It contains a full set of configuration files.

Best regards Christian