Skip to content
Permalink
Browse files

updated docs

  • Loading branch information...
p3root committed Mar 4, 2019
1 parent 317ae27 commit 6c238453fe1d3dad7bf5f71547a0d17c27366595
Showing with 694 additions and 505 deletions.
  1. +1 −0 Readme.md
  2. +2 −0 src/automatica.core/Automatica.Core.Doc/dev/backend/architecture.md
  3. +41 −41 src/automatica.core/Automatica.Core.Doc/dev/{ → backend}/automatica-cli.md
  4. +1 −0 src/automatica.core/Automatica.Core.Doc/dev/backend/development.md
  5. +149 −153 src/automatica.core/Automatica.Core.Doc/dev/{ → backend/drivers}/drivers.md
  6. +2 −0 src/automatica.core/Automatica.Core.Doc/dev/backend/intro.md
  7. 0 src/automatica.core/Automatica.Core.Doc/dev/{ → backend/logics}/logics.md
  8. +2 −0 src/automatica.core/Automatica.Core.Doc/dev/frontend/architecture.md
  9. +39 −0 src/automatica.core/Automatica.Core.Doc/dev/frontend/development.md
  10. +2 −0 src/automatica.core/Automatica.Core.Doc/dev/frontend/intro.md
  11. +2 −10 src/automatica.core/Automatica.Core.Doc/dev/intro.md
  12. +29 −6 src/automatica.core/Automatica.Core.Doc/dev/toc.yml
  13. +96 −79 src/automatica.core/Automatica.Core.Doc/docfx.json
  14. +57 −0 src/automatica.core/Automatica.Core.Doc/how-to/amazon/alexa.md
  15. +12 −0 src/automatica.core/Automatica.Core.Doc/how-to/intro.md
  16. +27 −0 src/automatica.core/Automatica.Core.Doc/how-to/openweathermap/intro.md
  17. +1 −0 src/automatica.core/Automatica.Core.Doc/how-to/suntime/intro.md
  18. +11 −0 src/automatica.core/Automatica.Core.Doc/how-to/toc.yml
  19. BIN src/automatica.core/Automatica.Core.Doc/images/alexa/AlexaApp1.jpg
  20. BIN src/automatica.core/Automatica.Core.Doc/images/alexa/AlexaApp2.jpg
  21. BIN src/automatica.core/Automatica.Core.Doc/images/alexa/AlexaApp3.jpg
  22. BIN src/automatica.core/Automatica.Core.Doc/images/alexa/AlexaApp4.jpg
  23. BIN src/automatica.core/Automatica.Core.Doc/images/alexa/AlexaApp5.jpg
  24. BIN src/automatica.core/Automatica.Core.Doc/images/alexa/AlexaApp6.jpg
  25. BIN src/automatica.core/Automatica.Core.Doc/images/alexa/AlexaApp7.jpg
  26. BIN src/automatica.core/Automatica.Core.Doc/images/alexa/AlexaApp8.jpg
  27. BIN src/automatica.core/Automatica.Core.Doc/images/alexa/AlexaApp9.jpg
  28. BIN src/automatica.core/Automatica.Core.Doc/images/alexa/Screenshot_1.png
  29. BIN src/automatica.core/Automatica.Core.Doc/images/alexa/Screenshot_2.png
  30. BIN src/automatica.core/Automatica.Core.Doc/images/alexa/Screenshot_3.png
  31. BIN src/automatica.core/Automatica.Core.Doc/images/owm/Screenshot_1.png
  32. BIN src/automatica.core/Automatica.Core.Doc/images/owm/Screenshot_2.png
  33. BIN src/automatica.core/Automatica.Core.Doc/images/owm/Screenshot_3.png
  34. BIN src/automatica.core/Automatica.Core.Doc/images/owm/Screenshot_4.png
  35. +15 −11 src/automatica.core/Automatica.Core.Doc/toc.yml
  36. +1 −0 src/automatica.core/Automatica.Core.Doc/user/drivers/automatica-remote/index.md
  37. +1 −0 src/automatica.core/Automatica.Core.Doc/user/drivers/constants/index.md
  38. +1 −0 src/automatica.core/Automatica.Core.Doc/user/drivers/enocean/index.md
  39. +1 −0 src/automatica.core/Automatica.Core.Doc/user/drivers/froniussymo/index.md
  40. +1 −0 src/automatica.core/Automatica.Core.Doc/user/drivers/homekit/index.md
  41. +1 −0 src/automatica.core/Automatica.Core.Doc/user/drivers/huebridge/index.md
  42. +1 −0 src/automatica.core/Automatica.Core.Doc/user/drivers/ikeatradfri/index.md
  43. +30 −31 src/automatica.core/Automatica.Core.Doc/user/drivers/index.md
  44. +1 −19 src/automatica.core/Automatica.Core.Doc/user/drivers/knx/index.md
  45. +1 −0 src/automatica.core/Automatica.Core.Doc/user/drivers/loxone/index.md
  46. +1 −0 src/automatica.core/Automatica.Core.Doc/user/drivers/machineflags/index.md
  47. +1 −0 src/automatica.core/Automatica.Core.Doc/user/drivers/mbus/index.md
  48. +1 −0 src/automatica.core/Automatica.Core.Doc/user/drivers/modbus/index.md
  49. +1 −0 src/automatica.core/Automatica.Core.Doc/user/drivers/openweathermap/index.md
  50. +1 −0 src/automatica.core/Automatica.Core.Doc/user/drivers/times/index.md
  51. +1 −0 src/automatica.core/Automatica.Core.Doc/user/drivers/wakeonlan/index.md
  52. +1 −0 src/automatica.core/Automatica.Core.Doc/user/drivers/zwave/index.md
  53. +4 −4 src/automatica.core/Automatica.Core.Doc/user/intro.md
  54. +1 −10 src/automatica.core/Automatica.Core.Doc/user/logic/compare/index.md
  55. +11 −10 src/automatica.core/Automatica.Core.Doc/user/logic/index.md
  56. +1 −10 src/automatica.core/Automatica.Core.Doc/user/logic/logic/index.md
  57. +1 −12 src/automatica.core/Automatica.Core.Doc/user/logic/math/index.md
  58. +1 −0 src/automatica.core/Automatica.Core.Doc/user/logic/messenger/index.md
  59. +1 −8 src/automatica.core/Automatica.Core.Doc/user/logic/time/index.md
  60. +23 −0 src/automatica.core/Automatica.Core.Doc/user/pages/intro.md
  61. +77 −48 src/automatica.core/Automatica.Core.Doc/user/toc.yml
  62. +0 −34 src/automatica.core/Automatica.Core.Doc/user/tutorials/index.md
  63. +3 −3 src/automatica.drivers/automatica.driver.constants/README.md
  64. +7 −2 src/automatica.drivers/automatica.driver.froniussymo/P3.Driver.FroniusSymo.sln
  65. +8 −0 src/automatica.drivers/automatica.driver.froniussymo/P3.Driver.FroniusSymo/Class1.cs
  66. +7 −0 ...tomatica.drivers/automatica.driver.froniussymo/P3.Driver.FroniusSymo/P3.Driver.FroniusSymo.csproj
  67. +2 −2 src/automatica.drivers/automatica.driver.homekit/README.md
  68. +3 −3 src/automatica.drivers/automatica.driver.machineflags/README.md
  69. +4 −4 src/automatica.drivers/automatica.driver.openweathermap.driver/README.md
  70. +5 −5 src/automatica.drivers/automatica.driver.times/README.md
@@ -84,6 +84,7 @@ The Structure of the project is as follows.
├── bin/ # Bin tools for splitting the repo
├── build/ # Some build tools for the project
├── docker/ # Docker build files
├── documentation/ # docfx documentation source
├── images/ # Image files displayed in the readme.md
├── src/ # Source files
| ├── automatica.core # The core system for automatica.core
@@ -0,0 +1,2 @@
# Architecture
The system is built using and modular approach.
@@ -1,42 +1,42 @@
# Automatica-CLI
A command line interface tool to generate/create/push Automatica.Core.Drivers/Automatica.Core.Rules.

## Install
`dotnet tool install automatica-cli`

## Usage
You can see all available commands using
`automatica-cli --help`

Here are the few important ones

### New project
Create a new Automatic.Core project using the `GenerateProject` command.

```
GenerateProject <Type> <ShortName> <FullName> [<OverwriteExisting>] -options - Generates a new Automatica driver or rule project
Option Description
Type* (-T) The type of the new project. Either driver or rule [Default='driver']
ShortName* (-S) The name of the new project
FullName* (-F) The name of the new project
OverwriteExisting (-O) Option to overwrite an existing destination folder [Default='False']
WorkingDirectory (-W) The working directory, if not set the current working directory will be used
```

### Pack
To pack your Automatica.Core project use the `Pack` command,
```
Pack -options - Generates a new Automatica driver or rule project
Option Description
Version* (-V) The package version
Configuration (-C) The package configuration [Default='Release']
WorkingDirectory (-W) The working directory, if not set the current working directory will be used
```
The generated package can be pushed to the [Automatica.Store](https://store.automaticacore.com).

### Push
TODO:

# Automatica-CLI
A command line interface tool to generate/create/push Automatica.Core.Drivers/Automatica.Core.Rules.

## Install
`dotnet tool install automatica-cli`

## Usage
You can see all available commands using
`automatica-cli --help`

Here are the few important ones

### New project
Create a new Automatic.Core project using the `GenerateProject` command.

```
GenerateProject <Type> <ShortName> <FullName> [<OverwriteExisting>] -options - Generates a new Automatica driver or rule project
Option Description
Type* (-T) The type of the new project. Either driver or rule [Default='driver']
ShortName* (-S) The name of the new project
FullName* (-F) The name of the new project
OverwriteExisting (-O) Option to overwrite an existing destination folder [Default='False']
WorkingDirectory (-W) The working directory, if not set the current working directory will be used
```

### Pack
To pack your Automatica.Core project use the `Pack` command,
```
Pack -options - Generates a new Automatica driver or rule project
Option Description
Version* (-V) The package version
Configuration (-C) The package configuration [Default='Release']
WorkingDirectory (-W) The working directory, if not set the current working directory will be used
```
The generated package can be pushed to the [Automatica.Store](https://store.automaticacore.com).

### Push
TODO:

To get your api-key please to to [developer.automaticacore.com](https://developer.automaticacore.com)
@@ -0,0 +1 @@
# Development

0 comments on commit 6c23845

Please sign in to comment.
You can’t perform that action at this time.