From ebc49d4a90cc4196104b386991b6220208eb0b2c Mon Sep 17 00:00:00 2001 From: David Antliff Date: Wed, 20 Jul 2016 09:57:05 +1200 Subject: [PATCH] Move doc images to their own subdirectory. Closes issue #245. Signed-off-by: David Antliff --- doc/3rdparty.md | 2 +- doc/Awa_Static_API.md | 8 ++++---- doc/coding_style.md | 2 +- doc/developer_guide.md | 6 +++--- doc/docker.md | 2 +- doc/example_api_list.md | 2 +- doc/example_app_api.md | 10 +++++----- doc/example_app_static_api.md | 6 +++--- ...WM2M_application_overview_constrained_device.png | Bin .../Awa_LWM2M_bootstrap_server-interfaces.png | Bin doc/{ => images}/Awa_LWM2M_server_interfaces.png | Bin .../Awa_application_overview-gateway_indicated.png | Bin doc/{ => images}/Awa_application_overview.png | Bin doc/{ => images}/Awa_client_API_structure.png | Bin doc/{ => images}/Awa_client_tutorial.png | Bin .../Awa_client_tutorial_application_positioning.png | Bin ..._tutorial_application_positioning_static_api.png | Bin .../Awa_client_tutorial_object_description.png | Bin doc/{ => images}/Awa_client_tutorial_static_api.png | Bin .../Awa_static_API_constrained_device.png | Bin ...wM2M_application_overview_constrained_device.png | Bin doc/{ => images}/LWM2M_object_referencing.png | Bin doc/{ => images}/awa_client_interfaces.png | Bin doc/{ => images}/client-tutorial.png | Bin doc/{ => images}/img.png | Bin .../pointer_mode_sparse_resource_distribution.png | Bin .../pointer_mode_uniform_resource_distribution.png | Bin doc/{ => images}/server-tutorial.png | Bin doc/lwm2m_overview.md | 2 +- doc/object_definition_files.md | 2 +- doc/rebasing_info.md | 2 +- doc/starters_guide.md | 2 +- doc/testing.md | 2 +- doc/userguide.md | 12 ++++++------ 34 files changed, 30 insertions(+), 30 deletions(-) rename doc/{ => images}/Awa_LWM2M_application_overview_constrained_device.png (100%) rename doc/{ => images}/Awa_LWM2M_bootstrap_server-interfaces.png (100%) rename doc/{ => images}/Awa_LWM2M_server_interfaces.png (100%) rename doc/{ => images}/Awa_application_overview-gateway_indicated.png (100%) rename doc/{ => images}/Awa_application_overview.png (100%) rename doc/{ => images}/Awa_client_API_structure.png (100%) rename doc/{ => images}/Awa_client_tutorial.png (100%) rename doc/{ => images}/Awa_client_tutorial_application_positioning.png (100%) rename doc/{ => images}/Awa_client_tutorial_application_positioning_static_api.png (100%) rename doc/{ => images}/Awa_client_tutorial_object_description.png (100%) rename doc/{ => images}/Awa_client_tutorial_static_api.png (100%) rename doc/{ => images}/Awa_static_API_constrained_device.png (100%) rename doc/{ => images}/FlowM2M_application_overview_constrained_device.png (100%) rename doc/{ => images}/LWM2M_object_referencing.png (100%) rename doc/{ => images}/awa_client_interfaces.png (100%) rename doc/{ => images}/client-tutorial.png (100%) mode change 100755 => 100644 rename doc/{ => images}/img.png (100%) rename doc/{ => images}/pointer_mode_sparse_resource_distribution.png (100%) rename doc/{ => images}/pointer_mode_uniform_resource_distribution.png (100%) rename doc/{ => images}/server-tutorial.png (100%) mode change 100755 => 100644 diff --git a/doc/3rdparty.md b/doc/3rdparty.md index 9ecf7d3..f87ed3d 100644 --- a/doc/3rdparty.md +++ b/doc/3rdparty.md @@ -1,5 +1,5 @@ -![](img.png) +![](images/img.png) ---- diff --git a/doc/Awa_Static_API.md b/doc/Awa_Static_API.md index 3ac6109..a24ddeb 100644 --- a/doc/Awa_Static_API.md +++ b/doc/Awa_Static_API.md @@ -1,5 +1,5 @@ -![](img.png) +![](images/img.png) ---- # The Awa Static API @@ -14,7 +14,7 @@ The management of constrained devices requires efficient lightweight protocols s The Awa LightweightM2M client is a small footprint LWM2M client implementation written in C. Its purpose is to abstract LWM2M functionality while integrating the required data structures with the device's main application code. All Awa LightweightM2M client functionality is accessed via the **Awa Static API**, which provides an interface between a constrained device's application code and LWM2M Client services. -![](Awa_static_API_constrained_device.png) +![](images/Awa_static_API_constrained_device.png) The Awa Static API is ideally suited to devices that have a fixed configuration and dedicated functionality. It provides a concise solution that enables the C data structures in the device application code to be directly accessed by the LWM2M Client. @@ -170,7 +170,7 @@ AwaError AwaStaticClient_SetResourceStorageWithPointer(AwaStaticClient * client, This results in fixed length resource instances being distributed continuously in memory as shown below: -![](pointer_mode_uniform_resource_distribution.png) +![](images/pointer_mode_uniform_resource_distribution.png) The parameters of the above function used to provide information about the location of each value in memory as shown in the diagram above are: @@ -192,7 +192,7 @@ AwaError AwaStaticClient_SetResourceStorageWithPointerArray(AwaStaticClient * cl This results in fixed length resource instances being distributed arbitrarily in memory as shown below: -![](pointer_mode_sparse_resource_distribution.png) +![](images/pointer_mode_sparse_resource_distribution.png) The parameters that provide information about the location of each value in memory as shown in the diagram above are: diff --git a/doc/coding_style.md b/doc/coding_style.md index af7bd28..0ce77d2 100644 --- a/doc/coding_style.md +++ b/doc/coding_style.md @@ -1,5 +1,5 @@ -![](img.png) +![](images/img.png) ---- diff --git a/doc/developer_guide.md b/doc/developer_guide.md index 8a7aa08..858a283 100644 --- a/doc/developer_guide.md +++ b/doc/developer_guide.md @@ -1,5 +1,5 @@ -![](img.png) +![](images/img.png) ---- @@ -17,7 +17,7 @@ LWM2M also provides a *bootstrap* mechanism, which helps a client to locate and LWM2M makes use of an *Object/Object Instance/Resource* (OIR) model to represent information. Objects are constructed from individual resource definitions, and each instance of an object is called an *Object Instance*. -![OIR model](LWM2M_object_referencing.png) +![OIR model](images/LWM2M_object_referencing.png) Refer to section [6.1 of the LWM2M technical specification](http://technical.openmobilealliance.org/Technical/technical-information/release-program/current-releases/oma-lightweightm2m-v1-0) for details. @@ -61,7 +61,7 @@ The static client API is designed for cases where the configuration will not cha ### The client The client consists of the *client core*, which coordinates the IPC layer (for communication with the client API), the static API, serialiser/deserialiser (*serdes*), CoAP, definition registry, data storage (*object tree*) and observer registry. -![Awa client API structure](Awa_client_API_structure.png) +![Awa client API structure](images/Awa_client_API_structure.png) #### The client core diff --git a/doc/docker.md b/doc/docker.md index 7b6474a..7d448a4 100644 --- a/doc/docker.md +++ b/doc/docker.md @@ -1,4 +1,4 @@ -![](img.png) +![](images/img.png) ---- # Using Awa with Docker diff --git a/doc/example_api_list.md b/doc/example_api_list.md index 04e23a7..3eaa437 100644 --- a/doc/example_api_list.md +++ b/doc/example_api_list.md @@ -1,5 +1,5 @@ -![](img.png) +![](images/img.png) ---- ## [client-defineset-example](../api/examples/client-defineset-example.c) diff --git a/doc/example_app_api.md b/doc/example_app_api.md index 43998ef..8698533 100644 --- a/doc/example_app_api.md +++ b/doc/example_app_api.md @@ -1,5 +1,5 @@ -![](img.png) +![](images/img.png) ---- @@ -10,7 +10,7 @@ ### Application overview -![](Awa_client_tutorial_application_positioning.png) +![](images/Awa_client_tutorial_application_positioning.png) This example shows how to: @@ -27,7 +27,7 @@ This example shows how to: The client-tutorial application makes use of the Awa API to define objects and resources and to register these with the client daemon: -![](client-tutorial.png) +![](images/client-tutorial.png) Note that this example assumes you have downloaded and decompressed (or git-cloned) Awa LWM2M into the directory `~/AwaLWM2M`. @@ -69,7 +69,7 @@ all: Now is a good time to define our objects and resources: -![](Awa_client_tutorial_object_description.png) +![](images/Awa_client_tutorial_object_description.png) To create the above object model the following code goes into tutorial/*client-tutorial.c*: @@ -287,7 +287,7 @@ So far our object definitions have remained local to the client. The next sectio Let's create a server side application that makes use of our new object. -![](server-tutorial.png) +![](images/server-tutorial.png) The following code registers our object definition with the LWM2M server daemon, allowing it to communicate with any LWM2M clients that support the same object. diff --git a/doc/example_app_static_api.md b/doc/example_app_static_api.md index 9e4576b..f6c5aff 100644 --- a/doc/example_app_static_api.md +++ b/doc/example_app_static_api.md @@ -1,5 +1,5 @@ -![](img.png) +![](images/img.png) ---- @@ -10,7 +10,7 @@ ### Application overview -![](Awa_client_tutorial_application_positioning_static_api.png) +![](images/Awa_client_tutorial_application_positioning_static_api.png) This example shows how to: @@ -23,7 +23,7 @@ This example shows how to: The *client-static-tutorial* application makes use of the Awa Static API to define objects and resources and to expose them via LWM2M: -![](Awa_client_tutorial_static_api.png) +![](images/Awa_client_tutorial_static_api.png) Note that this example assumes you have downloaded and decompressed (or git-cloned) Awa LWM2M into the directory `~/AwaLWM2M`. diff --git a/doc/Awa_LWM2M_application_overview_constrained_device.png b/doc/images/Awa_LWM2M_application_overview_constrained_device.png similarity index 100% rename from doc/Awa_LWM2M_application_overview_constrained_device.png rename to doc/images/Awa_LWM2M_application_overview_constrained_device.png diff --git a/doc/Awa_LWM2M_bootstrap_server-interfaces.png b/doc/images/Awa_LWM2M_bootstrap_server-interfaces.png similarity index 100% rename from doc/Awa_LWM2M_bootstrap_server-interfaces.png rename to doc/images/Awa_LWM2M_bootstrap_server-interfaces.png diff --git a/doc/Awa_LWM2M_server_interfaces.png b/doc/images/Awa_LWM2M_server_interfaces.png similarity index 100% rename from doc/Awa_LWM2M_server_interfaces.png rename to doc/images/Awa_LWM2M_server_interfaces.png diff --git a/doc/Awa_application_overview-gateway_indicated.png b/doc/images/Awa_application_overview-gateway_indicated.png similarity index 100% rename from doc/Awa_application_overview-gateway_indicated.png rename to doc/images/Awa_application_overview-gateway_indicated.png diff --git a/doc/Awa_application_overview.png b/doc/images/Awa_application_overview.png similarity index 100% rename from doc/Awa_application_overview.png rename to doc/images/Awa_application_overview.png diff --git a/doc/Awa_client_API_structure.png b/doc/images/Awa_client_API_structure.png similarity index 100% rename from doc/Awa_client_API_structure.png rename to doc/images/Awa_client_API_structure.png diff --git a/doc/Awa_client_tutorial.png b/doc/images/Awa_client_tutorial.png similarity index 100% rename from doc/Awa_client_tutorial.png rename to doc/images/Awa_client_tutorial.png diff --git a/doc/Awa_client_tutorial_application_positioning.png b/doc/images/Awa_client_tutorial_application_positioning.png similarity index 100% rename from doc/Awa_client_tutorial_application_positioning.png rename to doc/images/Awa_client_tutorial_application_positioning.png diff --git a/doc/Awa_client_tutorial_application_positioning_static_api.png b/doc/images/Awa_client_tutorial_application_positioning_static_api.png similarity index 100% rename from doc/Awa_client_tutorial_application_positioning_static_api.png rename to doc/images/Awa_client_tutorial_application_positioning_static_api.png diff --git a/doc/Awa_client_tutorial_object_description.png b/doc/images/Awa_client_tutorial_object_description.png similarity index 100% rename from doc/Awa_client_tutorial_object_description.png rename to doc/images/Awa_client_tutorial_object_description.png diff --git a/doc/Awa_client_tutorial_static_api.png b/doc/images/Awa_client_tutorial_static_api.png similarity index 100% rename from doc/Awa_client_tutorial_static_api.png rename to doc/images/Awa_client_tutorial_static_api.png diff --git a/doc/Awa_static_API_constrained_device.png b/doc/images/Awa_static_API_constrained_device.png similarity index 100% rename from doc/Awa_static_API_constrained_device.png rename to doc/images/Awa_static_API_constrained_device.png diff --git a/doc/FlowM2M_application_overview_constrained_device.png b/doc/images/FlowM2M_application_overview_constrained_device.png similarity index 100% rename from doc/FlowM2M_application_overview_constrained_device.png rename to doc/images/FlowM2M_application_overview_constrained_device.png diff --git a/doc/LWM2M_object_referencing.png b/doc/images/LWM2M_object_referencing.png similarity index 100% rename from doc/LWM2M_object_referencing.png rename to doc/images/LWM2M_object_referencing.png diff --git a/doc/awa_client_interfaces.png b/doc/images/awa_client_interfaces.png similarity index 100% rename from doc/awa_client_interfaces.png rename to doc/images/awa_client_interfaces.png diff --git a/doc/client-tutorial.png b/doc/images/client-tutorial.png old mode 100755 new mode 100644 similarity index 100% rename from doc/client-tutorial.png rename to doc/images/client-tutorial.png diff --git a/doc/img.png b/doc/images/img.png similarity index 100% rename from doc/img.png rename to doc/images/img.png diff --git a/doc/pointer_mode_sparse_resource_distribution.png b/doc/images/pointer_mode_sparse_resource_distribution.png similarity index 100% rename from doc/pointer_mode_sparse_resource_distribution.png rename to doc/images/pointer_mode_sparse_resource_distribution.png diff --git a/doc/pointer_mode_uniform_resource_distribution.png b/doc/images/pointer_mode_uniform_resource_distribution.png similarity index 100% rename from doc/pointer_mode_uniform_resource_distribution.png rename to doc/images/pointer_mode_uniform_resource_distribution.png diff --git a/doc/server-tutorial.png b/doc/images/server-tutorial.png old mode 100755 new mode 100644 similarity index 100% rename from doc/server-tutorial.png rename to doc/images/server-tutorial.png diff --git a/doc/lwm2m_overview.md b/doc/lwm2m_overview.md index ad33c23..2832235 100644 --- a/doc/lwm2m_overview.md +++ b/doc/lwm2m_overview.md @@ -1,5 +1,5 @@  -![](img.png) +![](images/img.png) ---- # LWM2M overview diff --git a/doc/object_definition_files.md b/doc/object_definition_files.md index ef3d48e..4730952 100644 --- a/doc/object_definition_files.md +++ b/doc/object_definition_files.md @@ -1,5 +1,5 @@ -![](img.png) +![](images/img.png) ---- # Object Definition files diff --git a/doc/rebasing_info.md b/doc/rebasing_info.md index 2e27f90..aefee26 100644 --- a/doc/rebasing_info.md +++ b/doc/rebasing_info.md @@ -1,6 +1,6 @@  -![](img.png) +![](images/img.png) ---- diff --git a/doc/starters_guide.md b/doc/starters_guide.md index c78bc6a..6df1c08 100644 --- a/doc/starters_guide.md +++ b/doc/starters_guide.md @@ -1,5 +1,5 @@ -![Imagination Technologies Limited logo](img.png) +![Imagination Technologies Limited logo](images/img.png) ---- diff --git a/doc/testing.md b/doc/testing.md index cc05fe7..f7102a1 100644 --- a/doc/testing.md +++ b/doc/testing.md @@ -1,5 +1,5 @@ -![](img.png) +![](images/img.png) ---- diff --git a/doc/userguide.md b/doc/userguide.md index 60b37fd..403efa3 100644 --- a/doc/userguide.md +++ b/doc/userguide.md @@ -1,5 +1,5 @@ -![](img.png) +![](images/img.png) ---- # Awa LightweightM2M @@ -50,7 +50,7 @@ Developers who aim to contribute to the Awa LightweightM2M project are referred ### Introduction -![Awa application overview](Awa_application_overview.png) +![Awa application overview](images/Awa_application_overview.png) LWM2M is a protocol that allows resources on a client to be accessed by a server. In the Awa library both the client and the server are daemon processes, each having its own respective API interface over an inter-process communication interface (IPC). The client API is for use exclusively with the client daemon, and the server API is for use exclusively with the server daemon. @@ -62,7 +62,7 @@ A bootstrap server daemon is included that implements the LWM2M bootstrapping pr ---- -![LWM2M object model](LWM2M_object_referencing.png) +![LWM2M object model](images/LWM2M_object_referencing.png) ---- @@ -120,7 +120,7 @@ The client provides two interfaces: * An IPC interface which provides a mechanism for applications to talk to the daemon -![Awa LWM2M client interfaces](awa_client_interfaces.png) +![Awa LWM2M client interfaces](images/awa_client_interfaces.png) The IPC interface allows the end user application to define new objects and to perform Get/Set/Delete/Subscribe operations on the client. @@ -164,7 +164,7 @@ Object definitions can be loaded into the client daemon before it attempts to bo The LWM2M server runs as a daemon which provides an interface to perform LWM2M operations on connected LWM2M clients. -![Awa LWM2M server interfaces](Awa_LWM2M_server_interfaces.png) +![Awa LWM2M server interfaces](images/Awa_LWM2M_server_interfaces.png) The IPC interface allows the end user application to define new objects, list registered clients and perform Read/Write/Delete/Observe operations for a given LWM2M client registered with the server. Currently the IPC interface is implemented as a simple UDP channel, with an associated UDP port. It is recommended that only a single user application connect to the daemon's IPC interface at any time. @@ -207,7 +207,7 @@ Object definitions can be loaded into the server daemon before it attempts to ac The LWM2M Bootstrap server runs as a daemon which provides a mechanism to bootstrap LWM2M clients. -![](Awa_LWM2M_bootstrap_server-interfaces.png) +![](images/Awa_LWM2M_bootstrap_server-interfaces.png) ### The Awa Bootstrap server daemon