Develop (#88)

* issues #69 API Notifications, SMS, telegram, slack, email * issues #84 update documentation * issues #64 technical debt * swagger * issues #64 technical debt * issues #84 update documentation * issues #84 update documentation
e154 · Nov 16, 2019 · 2f3fb8f · 2f3fb8f
1 parent 3bfe971
commit 2f3fb8f
Show file tree

Hide file tree

Showing 34 changed files with 2,929 additions and 163 deletions.
diff --git a/doc/config.yaml b/doc/config.yaml
@@ -13,6 +13,7 @@ taxonomies:
 Languages:
   ru:
     languageName: "Русский"
+    apiUrl: "https://sh.e154.ru/api/v1/swagger/swagger.yml"
     params:
       name: "Your name"
       description: "Your description"
@@ -73,6 +74,12 @@ Languages:
         - title: "IC.Log"
           url: "#ic_log"
 
+        - title: "IC.Template()"
+          url: "#ic_template"
+
+        - title: "IC.Notifr()"
+          url: "#ic_notifr"
+
         - title: "IC.CurrentNode()"
           url: "#ic_current_node"
         - title: "IC.CurrentDevice()"
@@ -91,10 +98,10 @@ Languages:
           url: "#device"
         - title: "Device{}"
           url: "#device"
-        - title: "Node{}"
-          url: "#node"
         - title: "MapElement{}"
           url: "#map_element"
+        - title: "Node{}"
+          url: "#node"
 
     getting_started_menu:
       links:
@@ -223,6 +230,7 @@ Languages:
 
   en:
     languageName: "English"
+    apiUrl: "https://sh.e154.ru/api/v1/swagger/swagger.yml"
     params:
       name: "Smart home"
       description: "Smart home system"
@@ -282,6 +290,12 @@ Languages:
         - title: "IC.Log"
           url: "#ic_log"
 
+        - title: "IC.Template()"
+          url: "#ic_template"
+
+        - title: "IC.Notifr()"
+          url: "#ic_notifr"
+
         - title: "IC.CurrentNode()"
           url: "#ic_current_node"
         - title: "IC.CurrentDevice()"
@@ -300,10 +314,10 @@ Languages:
           url: "#device"
         - title: "Device{}"
           url: "#device"
-        - title: "Node{}"
-          url: "#node"
         - title: "MapElement{}"
           url: "#map_element"
+        - title: "Node{}"
+          url: "#node"
 
     getting_started_menu:
       links:

diff --git a/doc/content/getting-started/_overview.en.md b/doc/content/getting-started/_overview.en.md
@@ -50,4 +50,4 @@ groups:
 
 Схематичная сеть **системы умного дома**:
 
-![Схематичная сеть умного дома](/smart-home/img/default_network.png "Схематичная сеть умного дома")
+![Схематичная сеть умного дома](/smart-home/img/smart-home-network.svg "Схематичная сеть умного дома")
diff --git a/doc/content/getting-started/_overview.md b/doc/content/getting-started/_overview.md
@@ -50,4 +50,4 @@ groups:
 
 Схематичная сеть **системы умного дома**:
 
-![Схематичная сеть умного дома](/smart-home/img/default_network.png "Схематичная сеть умного дома")
+![Схематичная сеть умного дома](/smart-home/img/smart-home-network.svg "Схематичная сеть умного дома")
diff --git a/doc/content/javascript/_device.en.md b/doc/content/javascript/_device.en.md
@@ -0,0 +1,98 @@
+---
+weight: 50
+title: device
+groups:
+    - javascript
+---
+
+## Device{} {#device}
+
+Получить текущее устройство. Может вырнуть *null* если скрипт запускается 
+вне контекста [Workflow](#ic_workflow)
+
+Доступные методы приведены далее:
+
+### .getName() {#deice_get_name}
+
+Получить наименование устройства.
+
+```coffeescript
+name = dev.getName()
+```
+
+**На выходе**
+
+**Значение** | **Описание**
+-------------|--------------
+  `name`     | type: string
+
+
+### .getDescription() {#deice_get_description}
+
+Получить описание устройства.
+
+```coffeescript
+description = dev.getDescription()
+```
+
+**На выходе**
+
+**Значение**    | **Описание**
+----------------|--------------
+  `description` | type: string
+
+### .runCommand(name, args) {#deice_run_command}
+
+Выполнить комманду на устройстве.
+
+```coffeescript
+description = dev.runCommand(name, ['foo','bar'])
+```
+
+**На выходе**
+
+**Значение**    | **Описание**
+----------------|--------------
+  `name`        | type: string
+  `args`        | type: array
+
+### .modBus(func, address, count, command) {#deice_mod_bus}
+
+Выполнить комманду на modbus устройстве.
+
+```coffeescript
+COMMAND = []
+FUNC = 'ReadHoldingRegisters'
+ADDRESS = 0
+COUNT = 16
+res = device.modBus(FUNC, ADDRESS, COUNT, COMMAND)
+if res.error
+  print 'error: ', res.error
+```
+
+**На выходе**
+
+**Значение**    | **Описание**
+----------------|--------------
+  `func`        | type: string, вызываемая функция 
+  `address`     | type: int, адрес устройства
+  `count`       | type: int
+  `command`     | type: array(int) 
+
+
+### .smartBus(command) {#deice_smart_bus}
+
+Выполнить комманду на smartbus устройстве.
+
+```coffeescript
+COMMAND = []
+res = device.smartBus(COMMAND)
+if res.error
+  print 'error: ', res.error
+```
+
+**На выходе**
+
+**Значение**    | **Описание**
+----------------|--------------
+  `command`     | type: array(int) 
diff --git a/doc/content/javascript/_device.md b/doc/content/javascript/_device.md
@@ -0,0 +1,98 @@
+---
+weight: 50
+title: device
+groups:
+    - javascript
+---
+
+## Device{} {#device}
+
+Получить текущее устройство. Может вырнуть *null* если скрипт запускается 
+вне контекста [Workflow](#ic_workflow)
+
+Доступные методы приведены далее:
+
+### .getName() {#deice_get_name}
+
+Получить наименование устройства.
+
+```coffeescript
+name = dev.getName()
+```
+
+**На выходе**
+
+**Значение** | **Описание**
+-------------|--------------
+  `name`     | type: string
+
+
+### .getDescription() {#deice_get_description}
+
+Получить описание устройства.
+
+```coffeescript
+description = dev.getDescription()
+```
+
+**На выходе**
+
+**Значение**    | **Описание**
+----------------|--------------
+  `description` | type: string
+
+### .runCommand(name, args) {#deice_run_command}
+
+Выполнить комманду на устройстве.
+
+```coffeescript
+description = dev.runCommand(name, ['foo','bar'])
+```
+
+**На выходе**
+
+**Значение**    | **Описание**
+----------------|--------------
+  `name`        | type: string
+  `args`        | type: array
+
+### .modBus(func, address, count, command) {#deice_mod_bus}
+
+Выполнить комманду на modbus устройстве.
+
+```coffeescript
+COMMAND = []
+FUNC = 'ReadHoldingRegisters'
+ADDRESS = 0
+COUNT = 16
+res = device.modBus(FUNC, ADDRESS, COUNT, COMMAND)
+if res.error
+  print 'error: ', res.error
+```
+
+**На выходе**
+
+**Значение**    | **Описание**
+----------------|--------------
+  `func`        | type: string, вызываемая функция 
+  `address`     | type: int, адрес устройства
+  `count`       | type: int
+  `command`     | type: array(int) 
+
+
+### .smartBus(command) {#deice_smart_bus}
+
+Выполнить комманду на smartbus устройстве.
+
+```coffeescript
+COMMAND = []
+res = device.smartBus(COMMAND)
+if res.error
+  print 'error: ', res.error
+```
+
+**На выходе**
+
+**Значение**    | **Описание**
+----------------|--------------
+  `command`     | type: array(int) 
diff --git a/doc/content/javascript/_flow.md b/doc/content/javascript/_flow.md
@@ -41,6 +41,23 @@ if flow
   `name`     | type: string
 
 
+### .getDescription() {#ic_flow_get_description}
+
+Получить описание текущего Flow процесса.
+
+```coffeescript
+flow = IC.Flow()
+if flow
+ name = flow.getDescription()
+ print 'flow description', name
+```
+
+**На выходе**
+
+**Значение** | **Описание**
+-------------|--------------
+  `description`     | type: string
+
 ### .setVar(key, value) {#ic_flow_set_var}
 
 Запомнить переменнную в хранилище [Flow](#ic_flow). Хранилище позволяет 

diff --git a/doc/content/javascript/_log.en.md b/doc/content/javascript/_log.en.md
@@ -1,5 +1,5 @@
 ---
-weight: 39
+weight: 35
 title: log
 groups:
     - javascript

diff --git a/doc/content/javascript/_log.md b/doc/content/javascript/_log.md
@@ -1,5 +1,5 @@
 ---
-weight: 39
+weight: 35
 title: log
 groups:
     - javascript

diff --git a/doc/content/javascript/_map.md b/doc/content/javascript/_map.md
@@ -15,23 +15,44 @@ map = IC.Map
 
 Доступные методы приведены далее:
 
-### .SetElementState(element, state) {#ic_map_set_element_state}
+### .SetElementState(device, elementName, newState) {#ic_map_set_element_state}
 
 ```coffeescript
 IC.Map.SetElementState(device, state)
 ```
 
 **На входе**
 
+**Значение**            | **Описание**
+------------------------|--------------
+  `device`              | type: Object, ссылка на объект [Device{}](#device)
+  `elementName`         | type: string, наименование элемента
+  `stnewStateate`       | type: string, системное наименование состояния
+
+### .GetElement(device, elementName) {#ic_map_get_element}
+
+```coffeescript
+elements = IC.Map.GetElement(device, elementName)
+```
+
+**На входе**
+
 **Значение**    | **Описание**
 ----------------|--------------
-  `element`      | type: Object, ссылка на объект карты
-  `state`       | type: string, системное наименование состояния
+  `device`      | type: Object, ссылка на объект [Device{}](#device)
+  `elementName` | type: string, наименование элемента
 
-### .GetElement(device) {#ic_map_get_element}
+
+**На выходе**
+
+**Значение**    | **Описание**
+----------------|--------------
+ `elements`     | type: Object, ссылка на объектов [MapElement{}](#map_element)
+
+### .GetElements(device) {#ic_map_get_element}
 
 ```coffeescript
-element = IC.Map.GetElement(device)
+elements = IC.Map.GetElement(device)
 ```
 
 **На входе**
@@ -40,9 +61,8 @@ element = IC.Map.GetElement(device)
 ----------------|--------------
   `device`      | type: Object, ссылка на объект [Device{}](#device)
 
-
 **На выходе**
 
 **Значение**    | **Описание**
 ----------------|--------------
- `element`      | type: Object, ссылка на объект [MapElement{}](#map_element)
+ `elements`     | type: Array, массив объектов [MapElement{}](#map_element)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -50,4 +50,4 @@ groups:

		Схематичная сеть системы умного дома:

		![Схематичная сеть умного дома](/smart-home/img/default_network.png "Схематичная сеть умного дома")
		![Схематичная сеть умного дома](/smart-home/img/smart-home-network.svg "Схематичная сеть умного дома")