.. _c-devices:

Devices
*******

TODO: Generic Device Description

.. _module:

Symphony Link Module
--------------------

TODO: Intro into the Symphony Link Modue.

The Symphony Link :class:`.Module` can be retrieved from the
:class:`.ConductorAccount` object via the :meth:`ConductorAccount.get_module`
method ::

    my_mod = account.get_module("$301$0-0-0-03000XXXX")

The :ref:`app-tok` and :ref:`net-tok` of the Module is set by the firmware
driving the device, however, they can be recieved as so ::

    my_mod.application_token
    > conductor.tokens.AppToken

    my_mod.network_token
    > conductor.tokens.NetToken

You can view which :ref:`gateway` the module used to register itself with, as
well as the time it occured the following properties ::

    my_mod.registered_by_gateway
    > conductor.devices.gateway.Gateway

    my_mod.registration_time
    > datetime.datetime.Datetime

You can view the the current Downlink Mode of the :class:`.Module` with the following
properties ::

    my_mod.downlink_mode
    > conductor.devices.module.Module.DownlinkMode

    # Then when in Mailbox Mode...
    my_mod.last_mailbox_request_time
    > datetime.datetime.Datetime

Refer to the :ref:`dl_modes` and :ref:`dl_mech` Sections for more information.

.. _ltem:

LTE CAT-M1 Module
-----------------

TODO: LTEm description

To get an :class:`.LTEmModule`, you can use the same method for the
:class:`.Module`: :meth:`ConductorAccount.get_module`. ::

    my_lte = account.get_module("$303$0-0-000XXXX-XXXXXXXXX")

The :ref:`ltem` module inherits all of its functionality from the
:class:`.Module`, but also has additional fields.

The LTEm Devices can be...

* Activated: :meth:`LTEmModule.activate`
* Deactivated :meth:`LTEmModule.deactivate`
* Suspeneded :meth:`LTEmModule.suspend`
* Restroed :meth:`LTEmModule.restore`

This affects the avalibility and billing of the LTEm devices. You can also
view the provisoning status of the LTEm with ::

    my_lte.provisioned_status
    > 'activated'

To register a brand new :class:`.LTEmModule`, the
:meth:`ConductorAccount.register_lte_module` method should be used. ::

    my_lte = account.register_lte_module(IMEI, ICCID, ZIP_CODE, my_app_token)
    my_lte.activate()

To view the Cellular Usage of the device ::

    my_lte.cell_data_usage
    > int

You can also reference the :ref:`ltem` module's ICCID and IMEI at anytime from
the Conductor Address of the device via the following properties ::

    my_lte.iccid
    > int

    my_lte.imei
    > long

To view the ID of the last cell tower communicated through, as well as the Tracking
Area Code ::

    my_lte.last_cell_id
    > int

    my_lte.last_cell_tac
    > int

Then, to view the firmware versions of the device, the following values should
be noted ::

    my_lte.version
    > conductor.util.Version

    my_lte.sqn_versions
    > (int, int)

    my_lte.mdn
    > int

    my_lte.min
    > int

    my_msisdn
    > int

.. _gateway:

Gateway
-------

TODO