diff options
author | Aleksander Morgado <aleksander@lanedo.com> | 2012-01-16 15:58:16 +0100 |
---|---|---|
committer | Aleksander Morgado <aleksander@lanedo.com> | 2012-03-15 14:14:51 +0100 |
commit | 38578f13b5b07f9a57b9407a2e2b8b34a8671f8e (patch) | |
tree | 4d90190a73bcb10d846cab455751524e7879aa58 | |
parent | b52e223f3026a60223a819899776f9b77c26380a (diff) |
docs: include initial state machine documentation
-rw-r--r-- | docs/reference/api/Makefile.am | 3 | ||||
-rw-r--r-- | docs/reference/api/ModemManager-states.dia | 1210 | ||||
-rw-r--r-- | docs/reference/api/ModemManager-states.png | bin | 0 -> 28305 bytes | |||
-rw-r--r-- | docs/reference/api/mm-overview.xml | 79 |
4 files changed, 1272 insertions, 20 deletions
diff --git a/docs/reference/api/Makefile.am b/docs/reference/api/Makefile.am index 69c11548..ea657d75 100644 --- a/docs/reference/api/Makefile.am +++ b/docs/reference/api/Makefile.am @@ -38,6 +38,7 @@ MKDB_OPTIONS = --output-format=xml --sgml-mode --name-space=mm # Images to copy into HTML directory HTML_IMAGES = \ + ModemManager-states.png \ $(NULL) content_files = \ @@ -75,6 +76,8 @@ EXTRA_DIST += \ mm-overview.xml \ mm-dbus-reference.xml \ version.xml.in \ + ModemManager-states.dia \ + ModemManager-states.png \ $(NULL) CLEANFILES += \ diff --git a/docs/reference/api/ModemManager-states.dia b/docs/reference/api/ModemManager-states.dia new file mode 100644 index 00000000..21e59479 --- /dev/null +++ b/docs/reference/api/ModemManager-states.dia @@ -0,0 +1,1210 @@ +<?xml version="1.0" encoding="UTF-8"?> +<dia:diagram xmlns:dia="http://www.lysator.liu.se/~alla/dia/"> + <dia:diagramdata> + <dia:attribute name="background"> + <dia:color val="#ffffff"/> + </dia:attribute> + <dia:attribute name="pagebreak"> + <dia:color val="#000099"/> + </dia:attribute> + <dia:attribute name="paper"> + <dia:composite type="paper"> + <dia:attribute name="name"> + <dia:string>#Letter#</dia:string> + </dia:attribute> + <dia:attribute name="tmargin"> + <dia:real val="2.5399999618530273"/> + </dia:attribute> + <dia:attribute name="bmargin"> + <dia:real val="2.5399999618530273"/> + </dia:attribute> + <dia:attribute name="lmargin"> + <dia:real val="2.5399999618530273"/> + </dia:attribute> + <dia:attribute name="rmargin"> + <dia:real val="2.5399999618530273"/> + </dia:attribute> + <dia:attribute name="is_portrait"> + <dia:boolean val="true"/> + </dia:attribute> + <dia:attribute name="scaling"> + <dia:real val="1"/> + </dia:attribute> + <dia:attribute name="fitto"> + <dia:boolean val="false"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + <dia:attribute name="grid"> + <dia:composite type="grid"> + <dia:attribute name="width_x"> + <dia:real val="1"/> + </dia:attribute> + <dia:attribute name="width_y"> + <dia:real val="1"/> + </dia:attribute> + <dia:attribute name="visible_x"> + <dia:int val="1"/> + </dia:attribute> + <dia:attribute name="visible_y"> + <dia:int val="1"/> + </dia:attribute> + <dia:composite type="color"/> + </dia:composite> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#d8e5e5"/> + </dia:attribute> + <dia:attribute name="guides"> + <dia:composite type="guides"> + <dia:attribute name="hguides"/> + <dia:attribute name="vguides"/> + </dia:composite> + </dia:attribute> + </dia:diagramdata> + <dia:layer name="Background" visible="true" active="true"> + <dia:object type="Flowchart - Box" version="0" id="O0"> + <dia:attribute name="obj_pos"> + <dia:point val="7,-1"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="6.95,-1.05;14.05,1.05"/> + </dia:attribute> + <dia:attribute name="elem_corner"> + <dia:point val="7,-1"/> + </dia:attribute> + <dia:attribute name="elem_width"> + <dia:real val="7"/> + </dia:attribute> + <dia:attribute name="elem_height"> + <dia:real val="2"/> + </dia:attribute> + <dia:attribute name="border_width"> + <dia:real val="0.10000000149011612"/> + </dia:attribute> + <dia:attribute name="inner_color"> + <dia:color val="#dadada"/> + </dia:attribute> + <dia:attribute name="show_background"> + <dia:boolean val="true"/> + </dia:attribute> + <dia:attribute name="padding"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#LOCKED#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="10.5,0.195"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="1"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + </dia:object> + <dia:object type="Flowchart - Box" version="0" id="O1"> + <dia:attribute name="obj_pos"> + <dia:point val="7,2"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="6.95,1.95;14.05,4.05"/> + </dia:attribute> + <dia:attribute name="elem_corner"> + <dia:point val="7,2"/> + </dia:attribute> + <dia:attribute name="elem_width"> + <dia:real val="7"/> + </dia:attribute> + <dia:attribute name="elem_height"> + <dia:real val="2"/> + </dia:attribute> + <dia:attribute name="border_width"> + <dia:real val="0.10000000149011612"/> + </dia:attribute> + <dia:attribute name="inner_color"> + <dia:color val="#fbc1bf"/> + </dia:attribute> + <dia:attribute name="show_background"> + <dia:boolean val="true"/> + </dia:attribute> + <dia:attribute name="padding"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#INITIALIZED#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="10.5,3.195"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="1"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + </dia:object> + <dia:object type="Flowchart - Box" version="0" id="O2"> + <dia:attribute name="obj_pos"> + <dia:point val="13,8"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="12.95,7.95;20.05,10.05"/> + </dia:attribute> + <dia:attribute name="elem_corner"> + <dia:point val="13,8"/> + </dia:attribute> + <dia:attribute name="elem_width"> + <dia:real val="7"/> + </dia:attribute> + <dia:attribute name="elem_height"> + <dia:real val="2"/> + </dia:attribute> + <dia:attribute name="border_width"> + <dia:real val="0.10000000149011612"/> + </dia:attribute> + <dia:attribute name="show_background"> + <dia:boolean val="true"/> + </dia:attribute> + <dia:attribute name="line_style"> + <dia:enum val="4"/> + </dia:attribute> + <dia:attribute name="padding"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#DISABLING#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="16.5,9.195"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="1"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + </dia:object> + <dia:object type="Flowchart - Box" version="0" id="O3"> + <dia:attribute name="obj_pos"> + <dia:point val="1,11"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="0.95,10.95;8.05,13.05"/> + </dia:attribute> + <dia:attribute name="elem_corner"> + <dia:point val="1,11"/> + </dia:attribute> + <dia:attribute name="elem_width"> + <dia:real val="7"/> + </dia:attribute> + <dia:attribute name="elem_height"> + <dia:real val="2"/> + </dia:attribute> + <dia:attribute name="border_width"> + <dia:real val="0.10000000149011612"/> + </dia:attribute> + <dia:attribute name="show_background"> + <dia:boolean val="true"/> + </dia:attribute> + <dia:attribute name="line_style"> + <dia:enum val="4"/> + </dia:attribute> + <dia:attribute name="padding"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#SEARCHING#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="4.5,12.195"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="1"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + </dia:object> + <dia:object type="Flowchart - Box" version="0" id="O4"> + <dia:attribute name="obj_pos"> + <dia:point val="7,14"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="6.95,13.95;14.05,16.05"/> + </dia:attribute> + <dia:attribute name="elem_corner"> + <dia:point val="7,14"/> + </dia:attribute> + <dia:attribute name="elem_width"> + <dia:real val="7"/> + </dia:attribute> + <dia:attribute name="elem_height"> + <dia:real val="2"/> + </dia:attribute> + <dia:attribute name="border_width"> + <dia:real val="0.10000000149011612"/> + </dia:attribute> + <dia:attribute name="inner_color"> + <dia:color val="#ffffbf"/> + </dia:attribute> + <dia:attribute name="show_background"> + <dia:boolean val="true"/> + </dia:attribute> + <dia:attribute name="padding"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#REGISTERED#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="10.5,15.195"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="1"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + </dia:object> + <dia:object type="Flowchart - Box" version="0" id="O5"> + <dia:attribute name="obj_pos"> + <dia:point val="13,17"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="12.95,16.95;20.05,18.95"/> + </dia:attribute> + <dia:attribute name="elem_corner"> + <dia:point val="13,17"/> + </dia:attribute> + <dia:attribute name="elem_width"> + <dia:real val="7"/> + </dia:attribute> + <dia:attribute name="elem_height"> + <dia:real val="1.9000000014901162"/> + </dia:attribute> + <dia:attribute name="border_width"> + <dia:real val="0.10000000149011612"/> + </dia:attribute> + <dia:attribute name="show_background"> + <dia:boolean val="true"/> + </dia:attribute> + <dia:attribute name="line_style"> + <dia:enum val="4"/> + </dia:attribute> + <dia:attribute name="padding"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#DISCONNECTING#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="16.5,18.145"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="1"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + </dia:object> + <dia:object type="Flowchart - Box" version="0" id="O6"> + <dia:attribute name="obj_pos"> + <dia:point val="1,17"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="0.95,16.95;8.05,18.95"/> + </dia:attribute> + <dia:attribute name="elem_corner"> + <dia:point val="1,17"/> + </dia:attribute> + <dia:attribute name="elem_width"> + <dia:real val="7"/> + </dia:attribute> + <dia:attribute name="elem_height"> + <dia:real val="1.9000000014901162"/> + </dia:attribute> + <dia:attribute name="border_width"> + <dia:real val="0.10000000149011612"/> + </dia:attribute> + <dia:attribute name="show_background"> + <dia:boolean val="true"/> + </dia:attribute> + <dia:attribute name="line_style"> + <dia:enum val="4"/> + </dia:attribute> + <dia:attribute name="padding"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#CONNECTING#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="4.5,18.145"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="1"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + </dia:object> + <dia:object type="Flowchart - Box" version="0" id="O7"> + <dia:attribute name="obj_pos"> + <dia:point val="7,20"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="6.95,19.95;14.05,22.05"/> + </dia:attribute> + <dia:attribute name="elem_corner"> + <dia:point val="7,20"/> + </dia:attribute> + <dia:attribute name="elem_width"> + <dia:real val="7"/> + </dia:attribute> + <dia:attribute name="elem_height"> + <dia:real val="2"/> + </dia:attribute> + <dia:attribute name="border_width"> + <dia:real val="0.10000000149011612"/> + </dia:attribute> + <dia:attribute name="inner_color"> + <dia:color val="#e5ffbc"/> + </dia:attribute> + <dia:attribute name="show_background"> + <dia:boolean val="true"/> + </dia:attribute> + <dia:attribute name="padding"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#CONNECTED#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="10.5,21.195"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="1"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + </dia:object> + <dia:object type="Standard - Line" version="0" id="O8"> + <dia:attribute name="obj_pos"> + <dia:point val="10.5,1"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="10.1382,0.95;10.8618,2.06298"/> + </dia:attribute> + <dia:attribute name="conn_endpoints"> + <dia:point val="10.5,1"/> + <dia:point val="10.5,1.95117"/> + </dia:attribute> + <dia:attribute name="numcp"> + <dia:int val="1"/> + </dia:attribute> + <dia:attribute name="end_arrow"> + <dia:enum val="22"/> + </dia:attribute> + <dia:attribute name="end_arrow_length"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="end_arrow_width"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:connections> + <dia:connection handle="0" to="O0" connection="13"/> + <dia:connection handle="1" to="O1" connection="16"/> + </dia:connections> + </dia:object> + <dia:object type="Standard - Arc" version="0" id="O9"> + <dia:attribute name="obj_pos"> + <dia:point val="14,3"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="13.9329,2.93292;16.5671,8.06708"/> + </dia:attribute> + <dia:attribute name="conn_endpoints"> + <dia:point val="14,3"/> + <dia:point val="16.5,8"/> + </dia:attribute> + <dia:attribute name="arc_color"> + <dia:color val="#800173"/> + </dia:attribute> + <dia:attribute name="curve_distance"> + <dia:real val="-0.59814818398119507"/> + </dia:attribute> + <dia:attribute name="line_width"> + <dia:real val="0.10000000149011612"/> + </dia:attribute> + <dia:attribute name="start_arrow"> + <dia:enum val="22"/> + </dia:attribute> + <dia:attribute name="start_arrow_length"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="start_arrow_width"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:connections> + <dia:connection handle="0" to="O1" connection="8"/> + <dia:connection handle="1" to="O2" connection="2"/> + </dia:connections> + </dia:object> + <dia:object type="Standard - Arc" version="0" id="O10"> + <dia:attribute name="obj_pos"> + <dia:point val="7,3"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="4.25187,2.92972;7.07028,5.07028"/> + </dia:attribute> + <dia:attribute name="conn_endpoints"> + <dia:point val="7,3"/> + <dia:point val="4.5,5"/> + </dia:attribute> + <dia:attribute name="arc_color"> + <dia:color val="#ff0000"/> + </dia:attribute> + <dia:attribute name="curve_distance"> + <dia:real val="0.62469504755442484"/> + </dia:attribute> + <dia:attribute name="line_width"> + <dia:real val="0.10000000149011612"/> + </dia:attribute> + <dia:attribute name="end_arrow"> + <dia:enum val="22"/> + </dia:attribute> + <dia:attribute name="end_arrow_length"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="end_arrow_width"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:connections> + <dia:connection handle="0" to="O1" connection="7"/> + <dia:connection handle="1" to="O18" connection="2"/> + </dia:connections> + </dia:object> + <dia:object type="Standard - Arc" version="0" id="O11"> + <dia:attribute name="obj_pos"> + <dia:point val="7,15.5"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="4.30534,15.3774;7.0686,17.0686"/> + </dia:attribute> + <dia:attribute name="conn_endpoints"> + <dia:point val="7,15.5"/> + <dia:point val="4.5,17"/> + </dia:attribute> + <dia:attribute name="arc_color"> + <dia:color val="#0000ff"/> + </dia:attribute> + <dia:attribute name="curve_distance"> + <dia:real val="0.62469504755442451"/> + </dia:attribute> + <dia:attribute name="line_width"> + <dia:real val="0.10000000149011612"/> + </dia:attribute> + <dia:attribute name="end_arrow"> + <dia:enum val="22"/> + </dia:attribute> + <dia:attribute name="end_arrow_length"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="end_arrow_width"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:connections> + <dia:connection handle="0" to="O4" connection="9"/> + <dia:connection handle="1" to="O6" connection="2"/> + </dia:connections> + </dia:object> + <dia:object type="Standard - Arc" version="0" id="O12"> + <dia:attribute name="obj_pos"> + <dia:point val="14,15.5"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="13.9314,15.165;16.5686,17.0686"/> + </dia:attribute> + <dia:attribute name="conn_endpoints"> + <dia:point val="14,15.5"/> + <dia:point val="16.5,17"/> + </dia:attribute> + <dia:attribute name="arc_color"> + <dia:color val="#1b6000"/> + </dia:attribute> + <dia:attribute name="curve_distance"> + <dia:real val="-0.37515315499923746"/> + </dia:attribute> + <dia:attribute name="line_width"> + <dia:real val="0.10000000149011612"/> + </dia:attribute> + <dia:attribute name="start_arrow"> + <dia:enum val="22"/> + </dia:attribute> + <dia:attribute name="start_arrow_length"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="start_arrow_width"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:connections> + <dia:connection handle="0" to="O4" connection="10"/> + <dia:connection handle="1" to="O5" connection="2"/> + </dia:connections> + </dia:object> + <dia:object type="Standard - Arc" version="0" id="O13"> + <dia:attribute name="obj_pos"> + <dia:point val="4.5,13"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="4.4314,12.9314;7.0686,14.8631"/> + </dia:attribute> + <dia:attribute name="conn_endpoints"> + <dia:point val="4.5,13"/> + <dia:point val="7,14.5"/> + </dia:attribute> + <dia:attribute name="arc_color"> + <dia:color val="#ff0000"/> + </dia:attribute> + <dia:attribute name="curve_distance"> + <dia:real val="0.40516540739917661"/> + </dia:attribute> + <dia:attribute name="line_width"> + <dia:real val="0.10000000149011612"/> + </dia:attribute> + <dia:attribute name="end_arrow"> + <dia:enum val="22"/> + </dia:attribute> + <dia:attribute name="end_arrow_length"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="end_arrow_width"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:connections> + <dia:connection handle="0" to="O3" connection="13"/> + <dia:connection handle="1" to="O4" connection="5"/> + </dia:connections> + </dia:object> + <dia:object type="Standard - Arc" version="0" id="O14"> + <dia:attribute name="obj_pos"> + <dia:point val="4.5,18.9"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="4.42956,18.8296;7.07044,21.385"/> + </dia:attribute> + <dia:attribute name="conn_endpoints"> + <dia:point val="4.5,18.9"/> + <dia:point val="7,21"/> + </dia:attribute> + <dia:attribute name="arc_color"> + <dia:color val="#0000ff"/> + </dia:attribute> + <dia:attribute name="curve_distance"> + <dia:real val="0.62469504755442451"/> + </dia:attribute> + <dia:attribute name="line_width"> + <dia:real val="0.10000000149011612"/> + </dia:attribute> + <dia:attribute name="end_arrow"> + <dia:enum val="22"/> + </dia:attribute> + <dia:attribute name="end_arrow_length"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="end_arrow_width"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:connections> + <dia:connection handle="0" to="O6" connection="13"/> + <dia:connection handle="1" to="O7" connection="7"/> + </dia:connections> + </dia:object> + <dia:object type="Standard - Arc" version="0" id="O15"> + <dia:attribute name="obj_pos"> + <dia:point val="14,21"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="13.9296,18.8296;16.7564,21.0704"/> + </dia:attribute> + <dia:attribute name="conn_endpoints"> + <dia:point val="14,21"/> + <dia:point val="16.5,18.9"/> + </dia:attribute> + <dia:attribute name="arc_color"> + <dia:color val="#1b6000"/> + </dia:attribute> + <dia:attribute name="curve_distance"> + <dia:real val="0.62469504755442451"/> + </dia:attribute> + <dia:attribute name="line_width"> + <dia:real val="0.10000000149011612"/> + </dia:attribute> + <dia:attribute name="end_arrow"> + <dia:enum val="22"/> + </dia:attribute> + <dia:attribute name="end_arrow_length"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="end_arrow_width"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:connections> + <dia:connection handle="0" to="O7" connection="8"/> + <dia:connection handle="1" to="O5" connection="13"/> + </dia:connections> + </dia:object> + <dia:object type="Standard - Arc" version="0" id="O16"> + <dia:attribute name="obj_pos"> + <dia:point val="14,14.5"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="13.932,9.93201;16.8393,14.568"/> + </dia:attribute> + <dia:attribute name="conn_endpoints"> + <dia:point val="14,14.5"/> + <dia:point val="16.5,10"/> + </dia:attribute> + <dia:attribute name="arc_color"> + <dia:color val="#800173"/> + </dia:attribute> + <dia:attribute name="curve_distance"> + <dia:real val="0.62469504755442451"/> + </dia:attribute> + <dia:attribute name="line_width"> + <dia:real val="0.10000000149011612"/> + </dia:attribute> + <dia:attribute name="end_arrow"> + <dia:enum val="22"/> + </dia:attribute> + <dia:attribute name="end_arrow_length"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="end_arrow_width"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:connections> + <dia:connection handle="0" to="O4" connection="6"/> + <dia:connection handle="1" to="O2" connection="13"/> + </dia:connections> + </dia:object> + <dia:object type="Flowchart - Box" version="0" id="O17"> + <dia:attribute name="obj_pos"> + <dia:point val="1,8"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="0.95,7.95;8.05,10.05"/> + </dia:attribute> + <dia:attribute name="elem_corner"> + <dia:point val="1,8"/> + </dia:attribute> + <dia:attribute name="elem_width"> + <dia:real val="7"/> + </dia:attribute> + <dia:attribute name="elem_height"> + <dia:real val="2"/> + </dia:attribute> + <dia:attribute name="border_width"> + <dia:real val="0.10000000149011612"/> + </dia:attribute> + <dia:attribute name="inner_color"> + <dia:color val="#ffffbf"/> + </dia:attribute> + <dia:attribute name="show_background"> + <dia:boolean val="true"/> + </dia:attribute> + <dia:attribute name="padding"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#ENABLED#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="4.5,9.195"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="1"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + </dia:object> + <dia:object type="Flowchart - Box" version="0" id="O18"> + <dia:attribute name="obj_pos"> + <dia:point val="1,5"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="0.95,4.95;8.05,7.05"/> + </dia:attribute> + <dia:attribute name="elem_corner"> + <dia:point val="1,5"/> + </dia:attribute> + <dia:attribute name="elem_width"> + <dia:real val="7"/> + </dia:attribute> + <dia:attribute name="elem_height"> + <dia:real val="2"/> + </dia:attribute> + <dia:attribute name="border_width"> + <dia:real val="0.10000000149011612"/> + </dia:attribute> + <dia:attribute name="show_background"> + <dia:boolean val="true"/> + </dia:attribute> + <dia:attribute name="line_style"> + <dia:enum val="4"/> + </dia:attribute> + <dia:attribute name="padding"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#ENABLING#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="4.5,6.195"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="1"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + </dia:object> + <dia:object type="Flowchart - Box" version="0" id="O19"> + <dia:attribute name="obj_pos"> + <dia:point val="7,-4"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="6.95,-4.05;14.05,-1.95"/> + </dia:attribute> + <dia:attribute name="elem_corner"> + <dia:point val="7,-4"/> + </dia:attribute> + <dia:attribute name="elem_width"> + <dia:real val="7"/> + </dia:attribute> + <dia:attribute name="elem_height"> + <dia:real val="2"/> + </dia:attribute> + <dia:attribute name="border_width"> + <dia:real val="0.10000000149011612"/> + </dia:attribute> + <dia:attribute name="show_background"> + <dia:boolean val="true"/> + </dia:attribute> + <dia:attribute name="line_style"> + <dia:enum val="4"/> + </dia:attribute> + <dia:attribute name="padding"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#INITIALIZING#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="10.5,-2.805"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="1"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + </dia:object> + <dia:object type="Standard - Text" version="1" id="O20"> + <dia:attribute name="obj_pos"> + <dia:point val="2.5,3.45"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="2.5,2.855;5.025,3.6025"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#ENABLE#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="2.5,3.45"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#ff0000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="0"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + <dia:attribute name="valign"> + <dia:enum val="3"/> + </dia:attribute> + </dia:object> + <dia:object type="Standard - Text" version="1" id="O21"> + <dia:attribute name="obj_pos"> + <dia:point val="1.5,15.85"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="1.5,15.255;4.655,16.0025"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#CONNECT#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="1.5,15.85"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#0000ff"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="0"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + <dia:attribute name="valign"> + <dia:enum val="3"/> + </dia:attribute> + </dia:object> + <dia:object type="Standard - Text" version="1" id="O22"> + <dia:attribute name="obj_pos"> + <dia:point val="15.755,21.1825"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="15.755,20.5875;20,21.335"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#DISCONNECT#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="15.755,21.1825"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#1b6000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="0"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + <dia:attribute name="valign"> + <dia:enum val="3"/> + </dia:attribute> + </dia:object> + <dia:object type="Standard - Text" version="1" id="O23"> + <dia:attribute name="obj_pos"> + <dia:point val="16,14"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="16,13.405;18.7425,14.1525"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#DISABLE#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="16,14"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#800173"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="0"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + <dia:attribute name="valign"> + <dia:enum val="3"/> + </dia:attribute> + </dia:object> + <dia:object type="Standard - Line" version="0" id="O24"> + <dia:attribute name="obj_pos"> + <dia:point val="10.5,-2"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="10.1382,-2.05;10.8618,-0.937025"/> + </dia:attribute> + <dia:attribute name="conn_endpoints"> + <dia:point val="10.5,-2"/> + <dia:point val="10.5,-1.04883"/> + </dia:attribute> + <dia:attribute name="numcp"> + <dia:int val="1"/> + </dia:attribute> + <dia:attribute name="end_arrow"> + <dia:enum val="22"/> + </dia:attribute> + <dia:attribute name="end_arrow_length"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="end_arrow_width"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:connections> + <dia:connection handle="0" to="O19" connection="13"/> + <dia:connection handle="1" to="O0" connection="16"/> + </dia:connections> + </dia:object> + <dia:object type="Standard - Line" version="0" id="O25"> + <dia:attribute name="obj_pos"> + <dia:point val="4.5,7"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="4.1382,6.95;4.8618,8.1118"/> + </dia:attribute> + <dia:attribute name="conn_endpoints"> + <dia:point val="4.5,7"/> + <dia:point val="4.5,8"/> + </dia:attribute> + <dia:attribute name="numcp"> + <dia:int val="1"/> + </dia:attribute> + <dia:attribute name="line_color"> + <dia:color val="#ff0000"/> + </dia:attribute> + <dia:attribute name="end_arrow"> + <dia:enum val="22"/> + </dia:attribute> + <dia:attribute name="end_arrow_length"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="end_arrow_width"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:connections> + <dia:connection handle="0" to="O18" connection="13"/> + <dia:connection handle="1" to="O17" connection="2"/> + </dia:connections> + </dia:object> + <dia:object type="Standard - Line" version="0" id="O26"> + <dia:attribute name="obj_pos"> + <dia:point val="4.5,10"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="4.1382,9.95;4.8618,11.1118"/> + </dia:attribute> + <dia:attribute name="conn_endpoints"> + <dia:point val="4.5,10"/> + <dia:point val="4.5,11"/> + </dia:attribute> + <dia:attribute name="numcp"> + <dia:int val="1"/> + </dia:attribute> + <dia:attribute name="line_color"> + <dia:color val="#ff0000"/> + </dia:attribute> + <dia:attribute name="end_arrow"> + <dia:enum val="22"/> + </dia:attribute> + <dia:attribute name="end_arrow_length"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="end_arrow_width"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:connections> + <dia:connection handle="0" to="O17" connection="13"/> + <dia:connection handle="1" to="O3" connection="2"/> + </dia:connections> + </dia:object> + <dia:object type="Standard - Line" version="0" id="O27"> + <dia:attribute name="obj_pos"> + <dia:point val="10.55,-6.0375"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="10.1533,-6.08871;10.8767,-3.88823"/> + </dia:attribute> + <dia:attribute name="conn_endpoints"> + <dia:point val="10.55,-6.0375"/> + <dia:point val="10.5,-4"/> + </dia:attribute> + <dia:attribute name="numcp"> + <dia:int val="1"/> + </dia:attribute> + <dia:attribute name="end_arrow"> + <dia:enum val="22"/> + </dia:attribute> + <dia:attribute name="end_arrow_length"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="end_arrow_width"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:connections> + <dia:connection handle="1" to="O19" connection="2"/> + </dia:connections> + </dia:object> + <dia:object type="Standard - Text" version="1" id="O28"> + <dia:attribute name="obj_pos"> + <dia:point val="8.8,-6.4675"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="8.8,-7.0625;12.0675,-6.315"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#INITIALIZE#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="8.8,-6.4675"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="0"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + <dia:attribute name="valign"> + <dia:enum val="3"/> + </dia:attribute> + </dia:object> + </dia:layer> +</dia:diagram> diff --git a/docs/reference/api/ModemManager-states.png b/docs/reference/api/ModemManager-states.png Binary files differnew file mode 100644 index 00000000..9ac1529a --- /dev/null +++ b/docs/reference/api/ModemManager-states.png diff --git a/docs/reference/api/mm-overview.xml b/docs/reference/api/mm-overview.xml index 675acabe..95764795 100644 --- a/docs/reference/api/mm-overview.xml +++ b/docs/reference/api/mm-overview.xml @@ -1,56 +1,95 @@ <?xml version="1.0"?> <!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ -<!ENTITY version SYSTEM "version.xml"> ]> -<part id="overview"> +<part id="ref-overview"> <title>ModemManager Overview</title> - <chapter id="overview-modemmanager"> - <title>ModemManager</title> + <chapter id="ref-overview-introduction"> + <title>Introduction</title> <para> ModemManager provides a unified high level API for communicating with (mobile broadband) modems. While the basic commands are standardized, the more advanced operations (like signal quality monitoring while connected) varies a lot. </para> - <formalpara> <title>Using</title> <para> ModemManager is a system daemon and is not meant to be used directly from - the command line. However, since it provides DBus API, it is possible to use - 'dbus-send' command to control it from the terminal. There's an example - program (tests/mm-test.py) that demonstrates the basic API usage. + the command line. However, a command line client (mmcli) is provided, which + may be used to test the different functionality provided during plugin + development. </para> </formalpara> - <formalpara> <title>Implementation</title> <para> ModemManager is a DBus system bus activated service (meaning it's started automatically when a request arrives). It is written in C. The devices are - queried from udev and automatically updated based on hardware events. There's - a GInterface (MMModem) that defines the modem interface and any device specific - implementation must implement it. There are two generic MMModem implementations - to support the basic operations (one for GSM, one for CDMA,) which are common - for all cards. + queried from udev and automatically updated based on hardware events. There are + DBus-interface specific GInterfaces, which should be implemented by any device + specific implementation. There is a generic MMBroadbandModem implementation that + provides a generic implementation of the most common operations in both GSM and + CDMA modems. </para> </formalpara> - <formalpara> <title>Plugins</title> <para> Plugins are loaded on startup, and must implement the MMPlugin interface. It consists of a couple of methods which tell the daemon whether the plugin - supports a port and to create custom MMModem implementations. It most likely + supports a port and to create custom modem implementations. It most likely makes sense to derive custom modem implementations from one of the generic - classes and just add (or override) operations which are not standard. There's a - fully working plugin in the plugins/ directory for Huawei cards that can be - used as an example for writing new plugins. Writing new plugins is highly - encouraged! + classes and just add (or override) operations which are not standard. Writing + new plugins is highly encouraged! </para> </formalpara> + </chapter> + <chapter id="ref-overview-states"> + <title>State machine</title> + <para> + ModemManager implements support for each Modem by controlling their + behaviour following the steps given in the following state machine. + </para> + <figure id="mm-modemmanager-states"> + <title>ModemManager states</title> + <graphic fileref="../ModemManager-states.png" format="PNG"></graphic> + </figure> + <para> + The state machine of a modem can be summarized in 5 main sequences: + initialization, enabling, connection, disconnection and disabling. + </para> + <section> + <title>Initialization</title> + <para> + <!-- TODO --> + </para> + </section> + <section> + <title>Enabling</title> + <para> + <!-- TODO --> + </para> + </section> + <section> + <title>Connection</title> + <para> + <!-- TODO --> + </para> + </section> + <section> + <title>Disconnection</title> + <para> + <!-- TODO --> + </para> + </section> + <section> + <title>Disabling</title> + <para> + <!-- TODO --> + </para> + </section> </chapter> </part> |