Skip to content

Commit

Permalink
Merge pull request ConnectivityFoundry#246 from DavidAntliff/issue-245
Browse files Browse the repository at this point in the history
Move doc images to their own subdirectory. Closes issue ConnectivityFoundry#245.
  • Loading branch information
seank-img authored Jul 20, 2016
2 parents ad624b5 + ebc49d4 commit adb79a8
Show file tree
Hide file tree
Showing 34 changed files with 30 additions and 30 deletions.
2 changes: 1 addition & 1 deletion doc/3rdparty.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

![](img.png)
![](images/img.png)

----

Expand Down
8 changes: 4 additions & 4 deletions doc/Awa_Static_API.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

![](img.png)
![](images/img.png)
----

# The Awa Static API
Expand All @@ -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.
Expand Down Expand Up @@ -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:
Expand All @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion doc/coding_style.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

![](img.png)
![](images/img.png)

----

Expand Down
6 changes: 3 additions & 3 deletions doc/developer_guide.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

![](img.png)
![](images/img.png)

----

Expand All @@ -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.

Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion doc/docker.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![](img.png)
![](images/img.png)
----

# Using Awa with Docker
Expand Down
2 changes: 1 addition & 1 deletion doc/example_api_list.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

![](img.png)
![](images/img.png)

----
## [client-defineset-example](../api/examples/client-defineset-example.c)
Expand Down
10 changes: 5 additions & 5 deletions doc/example_app_api.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

![](img.png)
![](images/img.png)

----

Expand All @@ -10,7 +10,7 @@

### Application overview

![](Awa_client_tutorial_application_positioning.png)
![](images/Awa_client_tutorial_application_positioning.png)

This example shows how to:

Expand All @@ -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`.

Expand Down Expand Up @@ -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*:

Expand Down Expand Up @@ -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.

Expand Down
6 changes: 3 additions & 3 deletions doc/example_app_static_api.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

![](img.png)
![](images/img.png)

----

Expand All @@ -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:

Expand All @@ -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`.

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
2 changes: 1 addition & 1 deletion doc/lwm2m_overview.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

![](img.png)
![](images/img.png)
----

# LWM2M overview
Expand Down
2 changes: 1 addition & 1 deletion doc/object_definition_files.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

![](img.png)
![](images/img.png)
----

# Object Definition files
Expand Down
2 changes: 1 addition & 1 deletion doc/rebasing_info.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@


![](img.png)
![](images/img.png)

----

Expand Down
2 changes: 1 addition & 1 deletion doc/starters_guide.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

![Imagination Technologies Limited logo](img.png)
![Imagination Technologies Limited logo](images/img.png)

----

Expand Down
2 changes: 1 addition & 1 deletion doc/testing.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

![](img.png)
![](images/img.png)

----

Expand Down
12 changes: 6 additions & 6 deletions doc/userguide.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

![](img.png)
![](images/img.png)
----

# Awa LightweightM2M
Expand Down Expand Up @@ -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.
Expand All @@ -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)

----

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit adb79a8

Please sign in to comment.