Files
ModemManager/docs/reference/libmm-glib/libmm-glib-docs.xml
Aleksander Morgado c4a584416a core: allow disabling auto-scan and notifying ports one by one via API
This commit enables a new core ModemManager daemon option, so that automatic
detection of available modems is totally disabled: '--no-auto-scan'. Note that
this option also replaces the previously used '--test-no-auto-scan' option,
which was only used during tests.

Along with the new ModemManager option, a new ReportKernelEvent() method in
the API is defined, which allows notifying the daemon of which interfaces it
should be accessing, as well as the main details of each interface. The only
mandatory parameters in the new method are 'action' (add/remove), 'name' (the
name of the interface) and 'subsystem' (the subsystem of the interface).

The mmcli tool has support for using the new api method via several new options:

 * The '--report-kernel-event' option allows specifying device ports one by
   one, and is a direct mapping of the ReportKernelEvent() method:
     $ sudo mmcli --report-kernel-event="action=add,name=wwan0,subsystem=net"
     $ sudo mmcli --report-kernel-event="action=add,name=cdc-wdm0,subsystem=usbmisc"

 * The '--report-kernel-event-auto-scan' option uses udev monitoring to notify
   events automatically to the daemon. This allows to operate in a way
   equivalent to the default daemon operation (with implicit auto-scan).

Worth noting that the ReportKernelEvent() method is only usable when
'--no-auto-scan' is explicitly used in the daemon. An error will be reported if
the method is tried while standard udev monitoring is enabled (implicit if
auto scan isn't explicitly disabled in the daemon).

If mmcli is going to be used only to report 'real time' events, an optional
'--initial-kernel-events=[PATH]' may be given in the ModemManager call to
automatically process a set of port kernel events one by one on boot. The file
may e.g. contain:
  action=add,name=wwan0,subsystem=net
  action=add,name=cdc-wdm0,subsystem=usbmisc
2016-09-29 15:43:05 +02:00

257 lines
8.7 KiB
XML

<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<book id="libmm-glib" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
<title>libmm-glib Reference Manual</title>
<subtitle>
<inlinemediaobject>
<imageobject>
<imagedata fileref="ModemManager-logo-wide.png" format="PNG" align="center"/>
</imageobject>
</inlinemediaobject>
</subtitle>
<releaseinfo>
For libmm-glib version &version;
</releaseinfo>
<authorgroup>
<author>
<firstname>Aleksander</firstname>
<surname>Morgado</surname>
<affiliation>
<address>
<email>aleksander@aleksander.es</email>
</address>
</affiliation>
</author>
</authorgroup>
<copyright>
<year>2011</year>
<year>2012</year>
<year>2013</year>
<year>2014</year>
<year>2015</year>
<year>2016</year>
<holder>The ModemManager Authors</holder>
</copyright>
<legalnotice>
<para>
Permission is granted to copy, distribute and/or modify this
document under the terms of the <citetitle>GNU Free
Documentation License</citetitle>, Version 1.3 or any later
version published by the Free Software Foundation with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover
Texts. You may obtain a copy of the <citetitle>GNU Free
Documentation License</citetitle> from the Free Software
Foundation by visiting <ulink type="http"
url="http://www.fsf.org">their Web site</ulink> or by writing
to:
<address>
The Free Software Foundation, Inc.
<street>51 Franklin Street</street>, Suite 500
<city>Boston</city>, <state>MA</state> <postcode>02110-1335</postcode>
<country>USA</country>
</address>
</para>
</legalnotice>
</bookinfo>
<part>
<title>High level API</title>
<chapter>
<title>Common enums and flags helpers</title>
<xi:include href="xml/mm-enums-types.xml"/>
</chapter>
<chapter>
<title>The Manager object</title>
<xi:include href="xml/mm-manager.xml"/>
<xi:include href="xml/mm-kernel-event-properties.xml"/>
</chapter>
<chapter>
<title>The Modem object</title>
<xi:include href="xml/mm-object.xml"/>
<section>
<title>Generic interfaces</title>
<xi:include href="xml/mm-modem.xml"/>
<xi:include href="xml/mm-modem-3gpp.xml"/>
<xi:include href="xml/mm-modem-3gpp-ussd.xml"/>
<xi:include href="xml/mm-modem-cdma.xml"/>
<xi:include href="xml/mm-cdma-manual-activation-properties.xml"/>
<xi:include href="xml/mm-unlock-retries.xml"/>
</section>
<section>
<title>Simple interface support</title>
<xi:include href="xml/mm-modem-simple.xml"/>
<xi:include href="xml/mm-simple-connect-properties.xml"/>
<xi:include href="xml/mm-simple-status.xml"/>
</section>
<section>
<title>Location support</title>
<xi:include href="xml/mm-modem-location.xml"/>
<xi:include href="xml/mm-location-3gpp.xml"/>
<xi:include href="xml/mm-location-gps-nmea.xml"/>
<xi:include href="xml/mm-location-gps-raw.xml"/>
<xi:include href="xml/mm-location-cdma-bs.xml"/>
</section>
<section>
<title>Messaging support</title>
<xi:include href="xml/mm-modem-messaging.xml"/>
</section>
<section>
<title>Time support</title>
<xi:include href="xml/mm-modem-time.xml"/>
<xi:include href="xml/mm-network-timezone.xml"/>
</section>
<section>
<title>Firmware support</title>
<xi:include href="xml/mm-modem-firmware.xml"/>
<xi:include href="xml/mm-firmware-properties.xml"/>
</section>
<section>
<title>Extended signal information</title>
<xi:include href="xml/mm-modem-signal.xml"/>
<xi:include href="xml/mm-signal.xml"/>
</section>
<section>
<title>OMA support</title>
<xi:include href="xml/mm-modem-oma.xml"/>
</section>
<section>
<title>Voice support</title>
<xi:include href="xml/mm-modem-voice.xml"/>
</section>
</chapter>
<chapter>
<title>The Bearer object</title>
<xi:include href="xml/mm-bearer.xml"/>
<xi:include href="xml/mm-bearer-properties.xml"/>
<xi:include href="xml/mm-bearer-ip-config.xml"/>
<xi:include href="xml/mm-bearer-stats.xml"/>
</chapter>
<chapter>
<title>The SIM object</title>
<xi:include href="xml/mm-sim.xml"/>
</chapter>
<chapter>
<title>The SMS object</title>
<xi:include href="xml/mm-sms.xml"/>
<xi:include href="xml/mm-sms-properties.xml"/>
</chapter>
<chapter>
<title>The Call object</title>
<xi:include href="xml/mm-call.xml"/>
<xi:include href="xml/mm-call-properties.xml"/>
</chapter>
</part>
<part>
<title>Low level API</title>
<xi:include href="xml/MmGdbusOrgFreedesktopModemManager1.xml"/>
<xi:include href="xml/MmGdbusOrgFreedesktopModemManager1Proxy.xml"/>
<xi:include href="xml/MmGdbusOrgFreedesktopModemManager1Skeleton.xml"/>
<xi:include href="xml/MmGdbusObjectManagerClient.xml"/>
<xi:include href="xml/MmGdbusObject.xml"/>
<xi:include href="xml/MmGdbusObjectProxy.xml"/>
<xi:include href="xml/MmGdbusObjectSkeleton.xml"/>
<xi:include href="xml/MmGdbusModem.xml"/>
<xi:include href="xml/MmGdbusModemProxy.xml"/>
<xi:include href="xml/MmGdbusModemSkeleton.xml"/>
<xi:include href="xml/MmGdbusModem3gpp.xml"/>
<xi:include href="xml/MmGdbusModem3gppProxy.xml"/>
<xi:include href="xml/MmGdbusModem3gppSkeleton.xml"/>
<xi:include href="xml/MmGdbusModem3gppUssd.xml"/>
<xi:include href="xml/MmGdbusModem3gppUssdProxy.xml"/>
<xi:include href="xml/MmGdbusModem3gppUssdSkeleton.xml"/>
<xi:include href="xml/MmGdbusModemCdma.xml"/>
<xi:include href="xml/MmGdbusModemCdmaProxy.xml"/>
<xi:include href="xml/MmGdbusModemCdmaSkeleton.xml"/>
<xi:include href="xml/MmGdbusModemLocation.xml"/>
<xi:include href="xml/MmGdbusModemLocationProxy.xml"/>
<xi:include href="xml/MmGdbusModemLocationSkeleton.xml"/>
<xi:include href="xml/MmGdbusModemMessaging.xml"/>
<xi:include href="xml/MmGdbusModemMessagingProxy.xml"/>
<xi:include href="xml/MmGdbusModemMessagingSkeleton.xml"/>
<xi:include href="xml/MmGdbusModemTime.xml"/>
<xi:include href="xml/MmGdbusModemTimeProxy.xml"/>
<xi:include href="xml/MmGdbusModemTimeSkeleton.xml"/>
<xi:include href="xml/MmGdbusModemFirmware.xml"/>
<xi:include href="xml/MmGdbusModemFirmwareProxy.xml"/>
<xi:include href="xml/MmGdbusModemFirmwareSkeleton.xml"/>
<xi:include href="xml/MmGdbusModemSignal.xml"/>
<xi:include href="xml/MmGdbusModemSignalProxy.xml"/>
<xi:include href="xml/MmGdbusModemSignalSkeleton.xml"/>
<xi:include href="xml/MmGdbusModemOma.xml"/>
<xi:include href="xml/MmGdbusModemOmaProxy.xml"/>
<xi:include href="xml/MmGdbusModemOmaSkeleton.xml"/>
<xi:include href="xml/MmGdbusModemVoice.xml"/>
<xi:include href="xml/MmGdbusModemVoiceProxy.xml"/>
<xi:include href="xml/MmGdbusModemVoiceSkeleton.xml"/>
<!--xi:include href="xml/MmGdbusModemContacts.xml"/>
<xi:include href="xml/MmGdbusModemContactsProxy.xml"/>
<xi:include href="xml/MmGdbusModemContactsSkeleton.xml"/-->
<xi:include href="xml/MmGdbusModemSimple.xml"/>
<xi:include href="xml/MmGdbusModemSimpleProxy.xml"/>
<xi:include href="xml/MmGdbusModemSimpleSkeleton.xml"/>
<xi:include href="xml/MmGdbusBearer.xml"/>
<xi:include href="xml/MmGdbusBearerProxy.xml"/>
<xi:include href="xml/MmGdbusBearerSkeleton.xml"/>
<xi:include href="xml/MmGdbusSim.xml"/>
<xi:include href="xml/MmGdbusSimProxy.xml"/>
<xi:include href="xml/MmGdbusSimSkeleton.xml"/>
<xi:include href="xml/MmGdbusSms.xml"/>
<xi:include href="xml/MmGdbusSmsProxy.xml"/>
<xi:include href="xml/MmGdbusSmsSkeleton.xml"/>
<xi:include href="xml/MmGdbusCall.xml"/>
<xi:include href="xml/MmGdbusCallProxy.xml"/>
<xi:include href="xml/MmGdbusCallSkeleton.xml"/>
</part>
<chapter id="object-tree">
<title>Object Hierarchy</title>
<xi:include href="xml/tree_index.sgml"/>
</chapter>
<index>
<title>API Index</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
</index>
<index id="deprecated-api-index" role="deprecated">
<title>Index of deprecated API</title>
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
</index>
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
</book>