Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Mihini/Device Management"
(→Commands) |
(→Commands) |
||
Line 25: | Line 25: | ||
| | | | ||
− | "1" | + | "1" → path.of.the.node.to.read (string), |
... | ... | ||
− | "n" | + | "n" → path.of.the.node.to.read (string) |
| | | | ||
Line 57: | Line 57: | ||
| | | | ||
---- | ---- | ||
− | "restart" | "1" | + | "restart" | "1" → restart after setting reset (boolean|number) |
| | | | ||
Line 87: | Line 87: | ||
ExecuteScript | ExecuteScript | ||
| | | | ||
− | "url" | "1" | + | "url" | "1" → url to retrieve the Lua script (string) <br> <br> |
− | signature | "2" | + | signature | "2" → signature of the script (string) |
| | | | ||
-> url to retrieve the Lua script <br> The Lua script can be either Lua source file or precompiled Lua bytecode file. <br> -> signature of Lua Script <br> The signature will fit the security level defined within the ReadyAgent. <br> First step: Signature will be '''MD5 hash''', and will be sent in '''hexa''' in an ascii string. | -> url to retrieve the Lua script <br> The Lua script can be either Lua source file or precompiled Lua bytecode file. <br> -> signature of Lua Script <br> The signature will fit the security level defined within the ReadyAgent. <br> First step: Signature will be '''MD5 hash''', and will be sent in '''hexa''' in an ascii string. | ||
Line 95: | Line 95: | ||
SoftwareUpdate | SoftwareUpdate | ||
| | | | ||
− | "url" | "1" | + | "url" | "1" → url to download the package (string) <br> <br> |
− | "signature" | "2" | + | "signature" | "2" → signature of the package (string) |
| | | | ||
-> url provided by the server where the Software Update Package can be downloaded. <br> Must '''not''' end by a trailing "/" character, unless archive name contains one (not recommended) <br> -> signature of the Software Update Package <br> The signature will fit the security level defined within the ReadyAgent. <br> First step: Signature will be '''MD5 hash''', and will be sent in '''hexa''' in an ascii string which size must be 32 chars (prefixing zeros chars must be sent!), and in lower case only. | -> url provided by the server where the Software Update Package can be downloaded. <br> Must '''not''' end by a trailing "/" character, unless archive name contains one (not recommended) <br> -> signature of the Software Update Package <br> The signature will fit the security level defined within the ReadyAgent. <br> First step: Signature will be '''MD5 hash''', and will be sent in '''hexa''' in an ascii string which size must be 32 chars (prefixing zeros chars must be sent!), and in lower case only. | ||
Line 113: | Line 113: | ||
LogUpload | LogUpload | ||
| | | | ||
− | "url" | "1" | + | "url" | "1" → url (string) <br> |
− | "logtype" | "2" | + | "logtype" | "2" → log type (string in \{"ram" or "flash" \} ) |
| | | | ||
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 <br> string equal to: "ram" to retrieve logs in ram (i.e. only from current ReadyAgent execution), or "flash" to get the logs from flash space <br> Note: The content of flash or ram buffer depends on the log policy defined in ReadyAgent Config | 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 <br> string equal to: "ram" to retrieve logs in ram (i.e. only from current ReadyAgent execution), or "flash" to get the logs from flash space <br> Note: The content of flash or ram buffer depends on the log policy defined in ReadyAgent Config | ||
Line 123: | Line 123: | ||
appcon.start | appcon.start | ||
| | | | ||
− | "appname" | "1" | + | "appname" | "1" → application name (string) |
| | | | ||
Start an application | Start an application | ||
Line 130: | Line 130: | ||
appcon.stop | appcon.stop | ||
| | | | ||
− | "appname" | "1" | + | "appname" | "1" → application name (string) |
| | | | ||
Stop an application | Stop an application | ||
Line 137: | Line 137: | ||
appcon.autostart | appcon.autostart | ||
| | | | ||
− | "appname" | "1" | + | "appname" | "1" → application name (string)<br> |
− | "autostart" | "2" | + | "autostart" | "2" → autostart flag(boolean) |
| | | | ||
Configure an application to start automatically or not. | Configure an application to start automatically or not. |
Revision as of 12:38, 1 March 2013
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. |
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