Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
en:sw:02-apis:01-evok [2024/08/07 10:35] – [Evok] kcernyen:sw:02-apis:01-evok [2025/09/22 10:50] (current) – rm tags ofojt
Line 2: Line 2:
 ~~NOTOC~~  ~~NOTOC~~ 
 <WRAP group> <WRAP group>
 +/*
 <WRAP half column 81%> <WRAP half column 81%>
 +*/
 {{ :en:sw:evok_1_.png?400&nolink |}} {{ :en:sw:evok_1_.png?400&nolink |}}
 +/*
 </WRAP> </WRAP>
 <WRAP half column 15%> <WRAP half column 15%>
Line 14: Line 17:
 ;;# ;;#
 </WRAP> </WRAP>
 +*/
 </WRAP> </WRAP>
  
-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.+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 our [[https://github.com/UniPiTechnology/evok|GitHub repository]].  Documentation, installation guide and description of APIs can be found at our [[https://github.com/UniPiTechnology/evok|GitHub repository]]. 
Line 24: Line 28:
 Evok is divided into two modules: Evok is divided into two modules:
   - Evok - the core handling the communication between all APIs and the hardware   - Evok - the core handling the communication between all APIs and the hardware
-  - Evok Web (optional) - a 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+  - Evok Web (optional) - a practical example of some of the APIs in a Web-based application which also serves as a simple UI of all I/of the unit
  
 Application logic and other operations (implementation 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}}*/
  
 ===== Available protocols ===== ===== Available protocols =====
Line 35: Line 39:
   * **WebSocket**   * **WebSocket**
   * **BULK**   * **BULK**
-  * **Webhook**  
   * **JSON-RPC**   * **JSON-RPC**
 \\ \\
Line 44: Line 47:
  
 <html><span class="kbBlueText">Quick examples using curl and JSON:</span></html> <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>:8080/json/di/1_01 --header 'Accept: text/html, application/json'</code> +  * Returning the state of digital input **DI 1_01**: <code>curl --request GET --url http://127.0.0.1:8080/json/di/1_01 --header 'Accept: text/html, application/json'</code> 
-  * Switch-on the **RO 2_01** relay: <code>curl --request POST --url http://192.168.1.2:8080/json/do/2_01 --header 'Accept: application/json' --header 'Content-Type: application/json' --data '{"value": 1}'</code> +  * Switch-on the **DO 1_01** digital output: <code>curl --request POST --url http://127.0.0.1:8080/json/do/1_01 --header 'Accept: application/json' --header 'Content-Type: application/json' --data '{"value": 1}'</code> 
-  * Switch-off the **RO 2_01** relay: <code>curl --request POST --url http://192.168.1.2:8080/json/do/2_01 --header 'Accept: application/json' --header 'Content-Type: application/json' --data '{"value": 0}'</code>+  * Switch-off the **DO 1_01** digital output: <code>curl --request POST --url http://127.0.0.1:8080/json/do/1_01 --header 'Accept: application/json' --header 'Content-Type: application/json' --data '{"value": 0}'</code
 + 
 +---- 
 + 
 +<WRAP group center round box 95%> 
 +{{ :files:img_warning-line_b.png?nolink |}} 
 +<WRAP half column 13%> 
 +{{ :en:hw:08_safety-instructions_pseudo-ISO-7010-info.png?nolink |(i)}} 
 +</WRAP> 
 +<WRAP half column 83%> 
 +**Older version of Evok:** \\ 
 +Legacy documentation of Evok v2 is available [[https://github.com/UniPiTechnology/evok/tree/master|here]], [[en:sw:02-apis:01-evok:apidoc-hidden|API documentation v2]] is also available. 
 +</WRAP> 
 +</WRAP>
  
-Legacy documentation of Evok v2 is available [[en:sw:02-apis:01-evok:installation|here]], [[en:sw:02-apis:01-evok:apidoc|API documentation]] is also available. 
  
 /*{{https://kb.unipi.technology/_media/en~:sw:02-evok:evok.html|API documentation}}*/ /*{{https://kb.unipi.technology/_media/en~:sw:02-evok:evok.html|API documentation}}*/