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 "Koneki/Simulators/OMA-DM/User Guide"
m (→The OMA-DM protocol) |
m (→The OMA-DM protocol) |
||
| Line 73: | Line 73: | ||
OMA-DM Protocol is based on the HTTP protocol. It exchanges xml data between the client and the OMA-DM server. | OMA-DM Protocol is based on the HTTP protocol. It exchanges xml data between the client and the OMA-DM server. | ||
| − | Data are represent by a tree nodes. This tree is save twice. Once on the device and once on the OMA-DM server. Each nodes contain four | + | Data are represent by a tree nodes. This tree is save twice. Once on the device and once on the OMA-DM server. Each nodes in the tree contain four informations |
| − | + | ||
| − | + | ||
| − | + | *Name : the name of the node | |
| − | + | *Data : the data of the node | |
| + | *Type : the Content-Type of the data | ||
| + | *Format : the format of the data | ||
| − | + | There are two types of node in the tree : nodes and leafs. For the nodes, Type an Data information are empty. Name is the name of the node. The value of Format is "node". For the leafs, all informations are fill.<br> | |
| − | *Add | + | The OMA-DM tree must contain some specific nodes and leafs. Some other nodes are just optional. Then, the tree can contain other nodes and leafs which are specific for the device. |
| − | *Delete | + | |
| − | *Get | + | The protocol provides some commands which could be send by the server and execute on the device. Bellow is the list of commands which are supported by the simulator |
| − | *Replace | + | |
| − | *Copy | + | *Add : insert a new node in the tree<br> |
| − | *Replace | + | *Delete : delete a node in the tree<br> |
| + | *Get : ask the data of one node<br> | ||
| + | *Replace : change the data of one node<br> | ||
| + | *Copy : copy the value of one node to another<br> | ||
| + | *Replace | ||
*Exec | *Exec | ||
Revision as of 09:02, 30 January 2012
Contents
Overview
The OMA-DM simulator provides to simulate communications between one application and one OMA-DM server. The simulator supports the current OMA Device Management Protocol version 1.2. The OMA-DM protocol is based on a tree node. This tree contains all informations which are shared with the OMA-DM server. Complete explications of the OMA-DM protocol are available on the third section : Concepts.
Getting started
Create a new OMA-DM simulator
Step 1 : Select wizard page
To create a new OMA-DM simulator you just have to select “OMA DM Simulator” in “File” → “New” → “Other” → “OMA Dm Simulator”.
Click one the "Next" button.
Step 2 : OMA DM simulation file page
Chose the location and the name of the future simulator file. Click on the “Next” button.
Click one the "Next" button.
Step 3 : Device configuration page
This page allowed to f</span>ill some basic informations in the OMA-DM tree.
Explications
- Server URI : the uri of the OMA-DM server you want to use
- Server login : the user name for the authentication on the OMA-DM server
- Server password : the user password for the authentication on the OMA-DM server
- Device ID : the id for the device which is simulate
Click one the "Next" button.
Step 4 : Device informations page
In this page you can fill basic information about the device. The Device Id must not be empty. Others data could stay empty.
Explications
- Device id : it's the same ID than the device ID in the previous step
- Manufacturer Nane : the manufacturer's name of the device
- Model Name : the model's name of the device
- Language : the current language of the application
Click one the "Next" button.
Step 5 : Device details page
In this page you can fill other information about the device.
Explications
- Device Type : The device ID type. Two others type are recognized ; "IMEI", "MAC". All other words will be translate in "FREE"
- OEM Name : the OEM's name of the device
- Firmware Revision : the current firmware version number
- Software Revision : the current software version number
- Hardware Revision : the current hardware version number
Click one the "Finish" button.
Concepts
The OMA-DM protocol
OMA-DM Protocol is based on the HTTP protocol. It exchanges xml data between the client and the OMA-DM server.
Data are represent by a tree nodes. This tree is save twice. Once on the device and once on the OMA-DM server. Each nodes in the tree contain four informations
- Name : the name of the node
- Data : the data of the node
- Type : the Content-Type of the data
- Format : the format of the data
There are two types of node in the tree : nodes and leafs. For the nodes, Type an Data information are empty. Name is the name of the node. The value of Format is "node". For the leafs, all informations are fill.
The OMA-DM tree must contain some specific nodes and leafs. Some other nodes are just optional. Then, the tree can contain other nodes and leafs which are specific for the device.
The protocol provides some commands which could be send by the server and execute on the device. Bellow is the list of commands which are supported by the simulator
- Add : insert a new node in the tree
- Delete : delete a node in the tree
- Get : ask the data of one node
- Replace : change the data of one node
- Copy : copy the value of one node to another
- Replace
- Exec
These commands are executed by the device just during the connection the connection of the device on the server.
Currently, the simulator support basic authentication on the OMA-DM server.
The complete specifications of the OMA-DM protocol and the nodes tree are available here : www.openmobilealliance.org/Technical/current_releases.aspx
Tasks
Once you created a new OMA-DM simulator, you can simulate a new connection on one OMA-SM server.
Simulate one connection by the device on the OMA-DM server
The simulator is divided in three tags.
The Configuration tag
The first tag is Configuration. It allows to fill basic information to authenticate the device on the server.
The Simulation tag
The second tag is Simulation. It allows to edit the OMA-DM tree. By default, the simulator create one basic tree with non optional nodes. You can find information that you filled in the Configuration tag in the OMA-DM tree. Bellow is the correspondence between information in the Configuration tag and the OMA-DM tree : Server URI : ./DMAcc/AppAuth/ServerID Server login : ./DMAcc/AppAuth/Default/AuthName Server password : ./DMAcc/AppAuth/Default/AuthSecret Device ID : ./DevInfo/DevId
The node "./DMAcc/AppAuth/Default" is an optional node. AuthName and AuthSecret can be saved anywhere in the "./DMAcc/AppAuth" node. The value of the these node can be change directly on the tree node since the Simulation tag. By this way, informations on the Configuration tag will be automatically updated.
The Dashboard tag
The last tag is the Dashborad. It allows to create a connection between the simulator and the OMA-DM server. It's during this connection that the OMA-DM commands will be executed. The server will throw commands and the simulator will execute them. In the Dashboard tag you have a short-cut to edit the value of the tree node.