Difference between revisions of "Mihini/Device Management"

From Eclipsepedia

Jump to: navigation, search
(Commands)
(Commands)
(2 intermediate revisions by one user not shown)
Line 13: Line 13:
 
!
 
!
 
'''Command Arguments<br>
 
'''Command Arguments<br>
'''<sub>name -&gt; description (type) </sub>
+
'''<sub>name &rarr; description (type) </sub>
  
 
!
 
!
Line 25: Line 25:
  
 
|
 
|
"1" -&gt; path.of.the.node.to.read (string),
+
"1" &rarr; path.of.the.node.to.read (string),
  
 
...
 
...
  
"n" -&gt; path.of.the.node.to.read (string)
+
"n" &rarr; path.of.the.node.to.read (string)
  
 
|
 
|
Line 57: Line 57:
 
|
 
|
 
----
 
----
"restart" | "1" -&gt; restart after setting reset (boolean|number)
+
"restart" | "1" &rarr; restart after setting reset (boolean|number)
  
 
|
 
|
Line 87: Line 87:
 
ExecuteScript
 
ExecuteScript
 
|
 
|
"url" | "1" -&gt; url to retrieve the Lua script (string) <br> <br>
+
"url" | "1" &rarr; url to retrieve the Lua script (string) <br> <br>
signature | "2" -&gt; signature of the script (string)
+
signature | "2" &rarr; signature of the script (string)
 
|
 
|
 
-&gt; url to retrieve the Lua script <br> The Lua script can be either Lua source file or precompiled Lua bytecode file. <br> -&gt; 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.
 
-&gt; url to retrieve the Lua script <br> The Lua script can be either Lua source file or precompiled Lua bytecode file. <br> -&gt; 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" -&gt; url to download the package (string) <br> <br>
+
"url" | "1" &rarr; url to download the package (string) <br> <br>
"signature" | "2" -&gt; signature of the package (string)
+
"signature" | "2" &rarr; signature of the package (string)
 
|
 
|
 
-&gt; 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> -&gt; 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.
 
-&gt; 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> -&gt; 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" -&gt; url (string) <br>
+
"url" | "1" &rarr; url (string) <br>
"logtype" | "2" -&gt; log type (string in \{"ram" or "flash" \} )
+
"logtype" | "2" &rarr; 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" -&gt; application name (string)
+
"appname" | "1" &rarr; application name (string)
 
|
 
|
 
Start an application
 
Start an application
Line 130: Line 130:
 
appcon.stop
 
appcon.stop
 
|
 
|
"appname" | "1" -&gt; application name (string)
+
"appname" | "1" &rarr; application name (string)
 
|
 
|
 
Stop an application
 
Stop an application
Line 137: Line 137:
 
appcon.autostart
 
appcon.autostart
 
|
 
|
"appname" | "1" -&gt; application name (string)<br>
+
"appname" | "1" &rarr; application name (string)<br>
"autostart" | "2" -&gt; autostart flag(boolean)
+
"autostart" | "2" &rarr; autostart flag(boolean)
 
|
 
|
 
Configure an application to start automatically or not.
 
Configure an application to start automatically or not.
Line 154: Line 154:
 
|-
 
|-
 
|
 
|
@sys.appcon.list
+
<code>@sys.appcon.list</code>
 
|
 
|
 
RO
 
RO
Line 161: Line 161:
 
|-
 
|-
 
|
 
|
@sys.appcon.apps.&lt;appname&gt;.started
+
<code>@sys.appcon.apps.&lt;appname&gt;.started</code>
 
|
 
|
 
RW
 
RW
Line 168: Line 168:
 
|-
 
|-
 
|
 
|
@sys.appcon.apps.&lt;appname&gt;.autostart
+
<code>@sys.appcon.apps.&lt;appname&gt;.autostart</code>
 
|
 
|
 
RW
 
RW
Line 175: Line 175:
 
|-
 
|-
 
|
 
|
@sys.appcon.apps.&lt;appname&gt;.runnable
+
<code>@sys.appcon.apps.&lt;appname&gt;.runnable</code>
 
|
 
|
 
RO
 
RO
Line 182: Line 182:
 
|-
 
|-
 
|
 
|
@sys.appcon.apps.&lt;appname&gt;.&lt;daemonattr&gt;
+
<code>@sys.appcon.apps.&lt;appname&gt;.&lt;daemonattr&gt;</code>
 
|
 
|
 
RO
 
RO

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
name → description (type)

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.
The node can be either terminal (a leaf: to get the value of a property) or have sub nodes. In the later case the content of the node and all its sub nodes will be transmitted.
This command provokes the sending of Data Messages that will contain the data associated to that node. The data of the message is composed of a map that hold the properties as key, and their value as value.

If a node contains a child, Data Messages will be sent recursively in order to present all the data of the sub nodes as well. If the specified node does not exist or contains no data, a nil value will be sent.

Note: path.of.the.node.to.read is a path that is not necessarily linked to the device or asset topology. In particular, the assetID is not repeated in that path.
Ex: Request bearer configuration it should use: "ReadNode config.network.bearers"

Connect

Ask the Mihini Agent to connect to the platform server.
The command must be addressed to the device (M3DA::Message.path = "@sys").

Reboot

Ask the device or one of its asset to reboot.
The device or the asset is designated thanks to the path of the M3DA::Message that wrap this command.

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.

Impacted modules/functionalities:

    • ReadyAgent persisted config is reset to defaultconfig

( depending on the differences between defaultconfig.lua and persisted config, this operation may impact: server url, hearbeat, ..., or any ReadyAgent config parameter)

    • Treemgr mapping are reset: it will be regenerated from .map files on next boot
    • Persisted M3DA data: asset and device data are reset
    • Applications installed in ApplicationContainer are erased
    • Update module:
      • deletion of any update in progress
      • software version list is cleared

Not impacted modules/functionalities:

    • M3DA security credentials are not cleared

Note:

    • This command is dependent on ReadyAgent integration, so ResetToFactoryDefault command implementation can differ from a device to another to fit integration needs, ReadyAgent product provides a generic implementation matching previous remarks




-> If this is a boolean value and it is true, it requests the agent to be restarted with a default timeout (6 seconds)
-> If this is a number and it is greater than zero, it requests the agent to be restarted in "restart" seconds

== Software update ==

ExecuteScript

"url" | "1" → url to retrieve the Lua script (string)

signature | "2" → signature of the script (string)

-> url to retrieve the Lua script
The Lua script can be either Lua source file or precompiled Lua bytecode file.
-> signature of Lua Script
The signature will fit the security level defined within the ReadyAgent.
First step: Signature will be MD5 hash, and will be sent in hexa in an ascii string.

SoftwareUpdate

"url" | "1" → url to download the package (string)

"signature" | "2" → signature of the package (string)

-> url provided by the server where the Software Update Package can be downloaded.
Must not end by a trailing "/" character, unless archive name contains one (not recommended)
-> signature of the Software Update Package
The signature will fit the security level defined within the ReadyAgent.
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.

== TCP Remote Connection ==

TCPRemoteConnect

Install a TCP tunnel

== Log Upload ==

LogUpload

"url" | "1" → url (string)
"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
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
Note: The content of flash or ram buffer depends on the log policy defined in ReadyAgent Config

== 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)
"autostart" | "2" → autostart flag(boolean)

Configure an application to start automatically or not.

Variables

Variable

Read/Write

Description

@sys.appcon.list

RO

list of all applications currently managed by appcon, as a single string of space-separated names

@sys.appcon.apps.<appname>.started

RW

whether the application is currently started (Boolean)

@sys.appcon.apps.<appname>.autostart

RW

whether the application starts automatically (Boolean)

@sys.appcon.apps.<appname>.runnable

RO

whether it is a runnable application

@sys.appcon.apps.<appname>.<daemonattr>

RO

The current value of every daemon attribute <daemonattr>. Current attributes include:
appname, priviledged, prog, wd, pid, startcount, lastexittype, lastexitcode

TBCompleted

Events

TBD