Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
en:sw:02-apis:01-evok [2020/05/26 06:40]
tomhora ↷ Page moved from en:sw:02-sdks:01-evok to en:sw:02-apis:01-evok
en:sw:02-apis:01-evok [2024/01/04 14:35] (current)
tomhora [Available protocols]
Line 1: Line 1:
-======%hide Evok ====== ​+====== Evok ====== ​  ​
 ~~NOTOC~~ ​ ~~NOTOC~~ ​
 +<WRAP group> 
 +<WRAP half column 81%>
 {{ :​en:​sw:​evok_1_.png?​400&​nolink |}} {{ :​en:​sw:​evok_1_.png?​400&​nolink |}}
 +</​WRAP>​
 +<WRAP half column 15%>
 +;;#
 +<​html><​span class="​dev-tag dev-patron">​Patron</​span></​html>​ \\
 +<​html><​span class="​dev-tag dev-neuron">​Neuron</​span></​html>​ \\
 +<​html><​span class="​dev-tag dev-gate">​Gate*</​span></​html>​ \\
 +<​html><​span class="​dev-tag dev-unipi11">​Unipi&​nbsp1.1</​span></​html>​ \\
 +<​html><​span class="​dev-tag dev-axon">​Axon</​span></​html>​
 +;;#
 +</​WRAP>​
 +</​WRAP>​
  
-The EVOK is our Open-Source application programming interface (API) providing interfaces to access physical inputs, outputs and communication interfaces. ​It'​s ​goal is to provide simple access to the hardware without the need of dealing ​with low-level programming.+The EVOK is our Open-Source application programming interface (API) providing interfaces to access physical inputs, outputs and communication interfaces. ​Its goal is to provide simple access to the hardware without the need to deal with low-level programming
 + 
 +Documentation,​ installation guide and description of APIs can be found at [[https://​github.com/​UniPiTechnology/​evok|GitHub repository]]
  
-Documentation,​ installation guide and descriptrion of APIs can be found at [[https://​github.com/​UniPiTechnology/​evok|GitHub repository]]. ​ 
  
 ===== Basic features ===== ===== Basic features =====
-Evok consis ​of two modules:+Evok consists ​of two modules:
   - Evok API - the core handling the communication between all APIs and the hardware   - Evok API - the core handling the communication between all APIs and the hardware
-  - Evok Web - practical example of some of the APIs in a Web based application which also server ​as a simple UI of of all I/Os of the controller+  - Evok Web - practical example of some of the APIs in a Web-based application which also serves ​as a simple UI of all I/Os of the unit
  
-Application logic and other operations (implementatios ​of different components of the system) should be handled by an external application.+Application logic and other operations (implementation ​of different components of the system) should be handled by an external application.
  
 {{:​en:​sw:​02-evok:​evokedited.png?​400|Simplified EVOK scheme}} {{:​en:​sw:​02-evok:​evokedited.png?​400|Simplified EVOK scheme}}
Line 24: Line 37:
   * **WebSocket** ​   * **WebSocket** ​
   * **JSON-RPC**   * **JSON-RPC**
 +\\
 +
 +<​html><​span class="​kbBlueText">​Quick examples using curl and JSON:</​span></​html>​
 +  * Returning the state of digital input **DI 1_01**: <​code>​curl --request GET --url http://​your-ip-goes-here:​8080/​json/​input/​1_01</​code>​
 +  * Switch-on the **RO 2_01** relay: <​code>​curl --request POST --url http://​your-ip-goes-here:​8080/​json/​output/​2_01 --header '​content-type:​ application/​json'​ --data '​{"​value":"​1"​}'</​code>​
 +  * Switch-off the **RO 2_01** relay: <​code>​curl --request POST --url http://​your-ip-goes-here:​8080/​json/​output/​2_01 --header '​content-type:​ application/​json'​ --data '​{"​value":"​0"​}'</​code>​
  
-Quick example which sets relay 1 On using curl: +See the {{https://kb.unipi.technology/​_media/​en~:​sw:​02-evok:evok.html | complete documentation including API usage examples}}.
-<​code>​ +
-curl --request GET -url http://your-ip-goes-here:8080/​json/​output/​1 +
-</​code>​+
  
-Complete documentation including API usage examples can be found at https://​evok-14.api-docs.io/​1.11/​ 
 ===== Full EVOK technical scheme ===== ===== Full EVOK technical scheme =====
 {{:​en:​sw:​02-evok:​neuron_diagram.png?​direct&​400|}} {{:​en:​sw:​02-evok:​neuron_diagram.png?​direct&​400|}}
  
 ~~NOCACHE~~ ~~NOCACHE~~