Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Last revision Both sides next revision | ||
|
en:sw:02-apis [2018/09/10 08:02] tomhora |
en:sw:02-apis [2023/04/21 10:19] avsetula |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ======%hide SDKs ===== | + | ======%hide APIs ====== |
| - | ~~NOTOC~~ | + | ~~NOTOC~~ |
| + | ====== Application Programming Interfaces (APIs) ====== | ||
| + | The APIs are low-level programming interfaces, ready to be used in custom software development (in languages such as C, Python, etc.). | ||
| - | ====== Software Development Kits (SDKs) ===== | + | We provide the following APIs for use with Unipi products: |
| - | The SDKs are low-level programming interfaces, ready to be used in a custom software development (C, Python,...). | + | |
| - | The tools are distributed via Debian packages on our repository http://repo.unipi.technology/debian/ | + | <tile> |
| + | | en:sw:02-apis:01-evok | | :files:unipi-kb-icon-evok.png | | ||
| + | | en:sw:02-apis:02-modbus-tcp | | :files:unipi-kb-icon-modbus.png | | ||
| + | | en:sw:02-apis:04-sysfs | | :files:unipi-kb-icon-sysfs.png | | ||
| + | </tile> | ||
| - | <WRAP center round info 60%> | + | /* [[en:sw:02-sdks:05-light|Unipi ModBus Light server]] */ |
| - | Currently, the packages are supported only for Axon and Neuron generations - Evok for UniPi 1 & lite should be [[en:sw:02-sdks:01-evok|installed as described]] | + | |
| - | </WRAP> | + | |
| - | ====== Installing SDKs via apt ====== | + | We also provide access to the internal Linux-based operating system via SSH, though this has to be enabled before use. |
| - | <WRAP center round tip 60%> | + | |
| - | The apt is already preconfigured on our Neuron and Axon official images. This guide should be followed only when installing on a clean Raspbian OS. | + | |
| - | </WRAP> | + | |
| - | Add the sources to the apt list | + | All of our software tools are distributed via [[en:sw:04-unipi-firmware|Debian packages in our repository]]. |
| - | <code> | + | |
| - | wget https://repo.unipi.technology/debian/unipi.list -O /etc/apt/sources.list.d/unipi.list | + | |
| - | wget https://repo.unipi.technology/debian/unipi_pub.gpg -O - | apt-key add | + | |
| - | </code> | + | |
| - | + | ||
| - | Let apt to update the unipi sources | + | |
| - | <code> | + | |
| - | apt-get update | + | |
| - | </code> | + | |
| - | + | ||
| - | And install the required kernel and unipi-firmware packages. This will automatically install the SysFS and Modbus TCP interfaces as well as support for RTC and serial lines. | + | |
| - | + | ||
| - | For UniPi Neuron: | + | |
| - | <code> | + | |
| - | apt-get install neuron-kernel unipi-firmware | + | |
| - | </code> | + | |
| - | + | ||
| - | For UniPi Axon: | + | |
| - | <code> | + | |
| - | apt-get install axon-kernel unipi-firmware | + | |
| - | </code> | + | |
| - | + | ||
| - | <WRAP center round important 60%> | + | |
| - | Make sure to reboot the system in order to apply the changes! | + | |
| - | </WRAP> | + | |
| + | ==== Compatibility table ==== | ||
| + | |< 100%>| | ||
| + | ^API ^ Patron ^ Neuron ^ Gate ^ Axon ^ Unipi 1.1 / Lite ^ | ||
| + | |EVOK | Yes | Yes | Only for communication\\ with Extension modules | Yes | Yes | | ||
| + | |ModbusTCP | Yes | Yes | Only storage life status | Yes | No | | ||
| + | |SysFS | Yes | Yes | Only storage life status | Yes | No | | ||
