Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Mihini/Device Management
Commands
This page references all generic commands used by the platform. The commands are serialized and sent using M3DA Protocol.
This is an "applicative level" specification opposed to the "serialization level" specification from the M3DA Protocol document.
In order to send command from the server to the device, or from the device to the server, an M3DA data writing is to be done on a node path, encapsulated into an M3DA::Message
object as stated into the protocol specification.
Command Name |
Command Arguments |
Comments |
---|---|---|
== Main == | ||
ReadNode |
"1" → path.of.the.node.to.read (string), ... "n" → path.of.the.node.to.read (string) |
Read a node or several nodes and its/their children (if any) from a tree.
Note: the path can be set to "" (empty string) to request the full tree content. However, as the tree can contain a great amount of data, this particuliar request must be done with caution. |
Connect |
Ask the Mihini Agent to connect to the platform server. | |
Reboot |
Ask the device or one of its asset to reboot. | |
ResetToFactoryDefault |
"restart" | "1" → restart after setting reset (boolean|number) |
Reset agent settings to factory defaults. All persisted data about agent settings and installed software are lost.
( depending on the differences between defaultconfig.lua and persisted config, this operation may impact: server url, hearbeat, ..., or any ReadyAgent config parameter)
Not impacted modules/functionalities:
Note:
-> If this is a boolean value and it is true, it requests the agent to be restarted with a default timeout (6 seconds) |
== Software update == | ||
ExecuteScript |
"url" | "1" → url to retrieve the Lua script (string) |
-> url to retrieve the Lua script |
SoftwareUpdate |
"url" | "1" → url to download the package (string) |
-> url provided by the server where the Software Update Package can be downloaded. |
== TCP Remote Connection == | ||
TCPRemoteConnect |
Install a TCP tunnel | |
== Log Upload == | ||
LogUpload |
"url" | "1" → url (string) |
The url where the logs are to be uploaded. Has to be of the form "ftp://" to request ftp upload, else "http://" for HTTP Post upload |
== Application Container == | ||
appcon.start |
"appname" | "1" → application name (string) |
Start an application |
appcon.stop |
"appname" | "1" → application name (string) |
Stop an application |
appcon.autostart |
"appname" | "1" → application name (string) |
Configure an application to start automatically or not. |
Variables
Variable |
Read/Write |
Description |
---|---|---|
|
RO |
list of all applications currently managed by appcon, as a single string of space-separated names |
|
RW |
whether the application is currently started (Boolean) |
|
RW |
whether the application starts automatically (Boolean) |
|
RO |
whether it is a runnable application |
|
RO |
The current value of every daemon attribute <daemonattr>. Current attributes include: |
TBCompleted
Events
TBD