Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
en:sw:02-apis:01-evok [2020/06/11 06:20] avsetula |
en:sw:02-apis:01-evok [2021/08/06 07:56] avsetula |
||
|---|---|---|---|
| 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 1.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. It's goal is to provide simple access to the hardware without the need of dealing with low-level programming. | ||
| Line 11: | Line 23: | ||
| Evok consis of two modules: | Evok consis 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 server as a simple UI of 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 (implementatios of different components of the system) should be handled by an external application. | ||
| Line 24: | Line 36: | ||
| * **WebSocket** | * **WebSocket** | ||
| * **JSON-RPC** | * **JSON-RPC** | ||
| + | \\ | ||
| - | Quick example which sets relay 1 On using curl: | + | <html><span class="kbBlueText">Quick examples using curl and JSON:</span></html> |
| - | <code> | + | * 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> |
| - | curl --request GET -url http://your-ip-goes-here:8080/json/output/1 | + | * 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> |
| - | </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> |
| Complete documentation including API usage examples can be found at https://evok-14.api-docs.io/1.11/ | 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~~ | ||
