====== Digilent Agent Reference Manual ======
The Digilent Agent is a service that runs in the system tray on Windows, Mac and Linux and enables browser based applications to communicate with Digilent hardware.

{{Digilent Image Gallery 
| image = {{ :reference:software:digilent-agent:digilent-agent-windows-tray-icon-closed.png?nolink |}}
| image = {{ :reference:software:digilent-agent:digilent-agent-windows-tray-icon-open.png?nolink |}}
}}


===== Overview =====
The Digilent Agent is an open source project developed using [[https://www.qt.io/ | Qt]].  All source code is available on [[https://github.com/Digilent/digilent-agent | GitHub]].  The agent hosts an HTTP server for communication with browser based GUIs (specifically WaveForms Live).  The controlling application sends [[software:digilent-agent:protocol]] commands to the Agent using HTTP POSTs to the /config endpoint with one or more JSON commands in the POST body.

===== Notes =====
The Digilent Agent requires access to COM ports to communicate with device like the OpenScope MZ.  Therefore the user account that launches the Agent must have permission to access COM ports.
  * Windows - No changes typically required.
  * Mac - No changes typically required.
  * Linux - User may need to be added to **dialout** group.  \\ ex. <code>usermod -a -G dialout <USERNAME></code>

===== Tutorials =====
----
{{topic>digilent-agent +tutorial}}