Component Manager

Note: To display only the features present on a particular device, select one or more filters from the SmartDocs bar below.

EMDK For Xamarin - 2.7

Overview

The ComponentMgr is used to configure the state and usage of subsystems such as Ethernet on the device.

The state defines whether a subsystem is On (active) or Off (inactive). Usage enables or disables the subsystem and controls whether its state can be changed (turned On or Off) by the device user through the System Settings Menu or programmatically using the ComponentMgr. If an attempt is made to use the ComponentMgr to control the state of a subsystem for which usage is currently disabled, an error will be returned in the Result XML document.

Note: Not every device will support every subsystem. For example, some devices have no support for Ethernet. If you try to use the ComponentMgr to control the state or usage of a subsystem that is not supported on a given device, then an error will be returned in the Result XML document.

Main Functionality

  • Turn Ethernet On or Off
  • Enable or Disable Ethernet Usage

Ethernet Usage

This parm allows you to control whether the state of the Ethernet Option can be changed.

If the usage of Ethernet is Disabled and then Enabled, the state of Ethernet, either On or Off, will be the same as it was before it was Disabled.

Parm Name: EthernetUsage

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no changes to whether the Ethernet can be used.

OSX: 4.4+

MX: 4.4+

1 Enable This value will cause the state of the Ethernet Option to be unlocked, allowing it to be changed, either by the device user or by the ComponentMgr.

OSX: 4.4+

MX: 4.4+

2 Disable This value will cause the state of the Ethernet Option to be locked, preventing it from being changed, either by the device user or by the ComponentMgr.

OSX: 4.4+

MX: 4.4+

Ethernet State

This parm allows you to change the state of the Ethernet Option to On or Off.

Parm Name: EthernetState

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no changes to whether the Ethernet Option is turned On or Off.

OSX: 4.4+

MX: 4.4+

1 Turn on This value will cause the Ethernet Option to be turned On, thus allowing the use of an Ethernet connection on the device.

OSX: 4.4+

MX: 4.4+

2 Turn off This value will cause the Ethernet Option to be turned Off, thus disallowing the use of an Ethernet connection on the device.

OSX: 4.4+

MX: 4.4+

Examples

Enabling Ethernet Usage and Turning On Ethernet

Input


<wap-provisioningdoc>
    <characteristic type="ComponentMgr" version="4.4">
        <parm name="EthernetUsage" value="1"/>
        <parm name="EthernetState" value="1"/>
    </characteristic>
</wap-provisioningdoc>

Error Output

The following XML is an example of an error that is returned when trying to set Ethernet features on a device that does not support Ethernet functionality.


<wap-provisioningdoc>
    <characteristic-error desc="exception" type="ComponentMgr" version="4.4" >
        <parm-error name="EthernetUsage" desc="Error in enabling Ethernet UI" value="1" />
        <parm-error name="EthernetState" desc="Failed to Turn On. Ethernet is disabled by admin" value="1" />
    </characteristic-error>
</wap-provisioningdoc>

Queries

Get the Ethernet Usage Value

This query will indicate if the state of the Ethernet Option can be changed.

Input


<wap-provisioningdoc>
    <characteristic type="ComponentMgr">
        <parm-query name="EthernetUsage"/>
    </characteristic>
</wap-provisioningdoc>

Output


<wap-provisioningdoc>
    <characteristic type="ComponentMgr" version="4.4">
        <parm name="EthernetUsage" value="1"/>
    </characteristic>
</wap-provisioningdoc>

Get the Ethernet State Value

This query will indicate if the Ethernet State of the device is currently set to On or Off.

Input


<wap-provisioningdoc>
    <characteristic type="ComponentMgr">
        <parm-query name="EthernetState"/>
    </characteristic>
</wap-provisioningdoc>

Output


<wap-provisioningdoc>
    <characteristic type="ComponentMgr" version="4.4">
        <parm name="EthernetState" value="1"/>
    </characteristic>
</wap-provisioningdoc>