Movesense

https://www.movesense.com/docs/
Admin
Movesense is an open development environment for motion sensing solutions that enables developers to...
Tokens:205,788
Snippets:1,229
Trust Score:9.2
Update:10 months ago
Show doc for...
Tokens:
Raw
### Hello World: GET Operation Example

Source: https://www.movesense.com/docs/esw/sample_applications

Example of performing a GET operation on the 'Hello World' resource using the wbcmd utility. Shows the command and the JSON response containing a greeting.

```bash
wbcmd --port COMx --path /Sample/HelloWorld --op GET

{
  "response": 200,
  "responsestring": "HTTP_CODE_OK",
  "operation": "get",
  "uri": "/net/ECKI6AF7F95A/Sample/HelloWorld",
  "content": {
    "Greeting": "Hello World!"
  },
  "querytimems": 28,
  "querytimens": 28776889
}

```

--------------------------------

### Start Timer in Module Start

Source: https://www.movesense.com/docs/esw_1.9/whiteboard

Shows how to start a timer when a module is initialized. By calling `startTimer` within the `startModule` method, the timer begins immediately after the module becomes active. This example starts a continuous timer with a 1000ms period.

```cpp
bool TestClient::startModule()
{
    mModuleState = WB_RES::ModuleStateValues::STARTED;
    mTimer = startTimer(1000, true);

    return true;
}

```

--------------------------------

### Timer Initialization and Usage Example (C++)

Source: https://www.movesense.com/docs/esw/whiteboard

Demonstrates how to declare, initialize, and start a timer within a client class. It's good practice to initialize timer IDs to `ID_INVALID_TIMER` and start timers in `startModule()`.

```cpp
class TestClient FINAL : private whiteboard::ResourceClient,
                         public whiteboard::LaunchableModule
{
    ...

private:
    whiteboard::TimerId mTimer;
};


TestClient::TestClient()
    : ResourceClient(WBDEBUG_NAME(__FUNCTION__), WB_EXEC_CTX_APPLICATION),
      LaunchableModule(LAUNCHABLE_NAME, WB_EXEC_CTX_APPLICATION)
{
    mTimer = whiteboard::ID_INVALID_TIMER;
}


bool TestClient::startModule()
{
    mModuleState = WB_RES::ModuleStateValues::STARTED;
    mTimer = startTimer(1000, true);

    return true;
}

```

--------------------------------

### ResourceClient Constructor Example

Source: https://www.movesense.com/docs/esw/whiteboard

An example of the ResourceClient constructor usage within a derived class. It initializes the client with a name and an execution context ID.

```cpp
const char* const TestService::LAUNCHABLE_NAME = "TestSvc";

TestService::TestService()
    : ResourceClient(WBDEBUG_NAME(__FUNCTION__), WB_EXEC_CTX_APPLICATION)
{}

```

--------------------------------

### Handling Incoming Requests

Source: https://www.movesense.com/docs/esw_1.9/whiteboard

This section details the methods to handle different types of incoming requests (GET, PUT, POST, DELETE). The default implementation returns 'Not Implemented'. Example implementations show how to process requests based on resource IDs.

```APIDOC
## Incoming Request Handling

This API provides methods to handle standard HTTP requests. Implementations must override the virtual methods for each request type. The default implementation returns `HTTP_CODE_NOT_IMPLEMENTED`.

### `onGetRequest`

Handles GET requests.

- **Method**: `virtual void onGetRequest(const Request& rRequest, const ParameterList& rParameters)`
- **Description**: Processes incoming GET requests. Can return `HTTP_CODE_SERVICE_UNAVAILABLE` if the module is not started, or `HTTP_CODE_NOT_FOUND` if the resource ID is not recognized.
- **Example Implementation**: Demonstrates handling GET requests for specific resource IDs and returning corresponding data or errors.

### `onPutRequest`

Handles PUT requests.

- **Method**: `virtual void onPutRequest(const Request& rRequest, const ParameterList& rParameters)`
- **Description**: Processes incoming PUT requests. Requires implementation based on service needs.

### `onPostRequest`

Handles POST requests.

- **Method**: `virtual void onPostRequest(const Request& rRequest, const ParameterList& rParameters)`
- **Description**: Processes incoming POST requests. Requires implementation based on service needs.

### `onDeleteRequest`

Handles DELETE requests.

- **Method**: `virtual void onDeleteRequest(const Request& rRequest, const ParameterList& rParameters)`
- **Description**: Processes incoming DELETE requests. Requires implementation based on service needs.

### `returnResult`

A utility function to return the result of a request.

- **Signature 1**: `template <typename V = NoType> void returnResult(const Request& rRequest, Result resultCode, const ResponseOptions& rOptions = ResponseOptions::Empty, const V& result = NoType::NoValue)`
- **Signature 2**: `template <typename RESPONSE, typename V = NoType, typename EnableIf<!IsSame<RESPONSE, Result>::value, int>::type = 0> void returnResult(const Request& rRequest, const RESPONSE& rResponse, const ResponseOptions& rOptions = ResponseOptions::Empty, const V& result = NoType::NoValue)`
- **Description**: Closes an incoming request by returning a result. Parameters include the request object, result code, response options, and the result data.
```

--------------------------------

### Get UI Visual Indication State (C++ SDK)

Source: https://www.movesense.com/docs/esw_1.9/api_reference

An example using the Movesense C++ SDK to asynchronously retrieve the current state of the device's red LED visual indications. It handles the response to determine the indication state.

```cpp
#include <ui_ind/resources.h>
...

void ExampleClient::getIndicationState() {
    asyncGet(WB_RES::LOCAL::UI_IND_VISUAL());
}

void ExampleClient::onGetResult(whiteboard::RequestId requestId,
                                whiteboard::ResourceId resourceId,
                                whiteboard::Result resultCode,
                                const whiteboard::Value& resultData)
{
    switch (resourceId.localResourceId)
    {
    case WB_RES::LOCAL::UI_IND_VISUAL::LID:
    {
        if (resultCode == whiteboard::HTTP_CODE_OK)
        {
           const WB_RES::VisualIndState& indicationState = resultData.convertTo<const WB_RES::VisualIndState&>();
           //handleResult(indicationState.state);
        }
        break;
    }
    }
}

```

--------------------------------

### Get MAX3000x Wakeup State (C++ SDK)

Source: https://www.movesense.com/docs/esw_1.9/api_reference

An example using the Movesense C++ SDK to asynchronously retrieve the wakeup configuration state for the MAX3000x analog front-end component. It handles the response to log the wakeup configuration.

```cpp
#include <component_max3000x/resources.h>
...

void ExampleClient::getWakeupConfig()
{
    asyncGet(WB_RES::LOCAL::COMPONENT_MAX3000X_WAKEUP());
}

void ExampleClient::onGetResult(whiteboard::RequestId requestId,
    whiteboard::ResourceId resourceId,
    whiteboard::Result resultCode,
    const whiteboard::Value& resultData)
{
    switch (resourceId.localResourceId)
    {
    case WB_RES::LOCAL::COMPONENT_MAX3000X_WAKEUP::LID:
    {
        if (resultCode == whiteboard::HTTP_CODE_OK)
        {
            auto wakeup = resultData.convertTo<const uint8_t&>();

            // handle state
            DebugLogger::info("Wakeup config: %d", wakeup);
        }
        else
        {
            // handle error
        }
        break;
    }
    }
}


```

--------------------------------

### Hello World: Subscription Operation Example

Source: https://www.movesense.com/docs/esw/sample_applications

Example of subscribing to the 'Hello World' resource using the wbcmd utility. Demonstrates the subscription command, initial response, and periodic notifications with increasing message counts.

```bash
wbcmd --port COMx --path /Sample/HelloWorld --op Subscribe
/net/ECKI6AF7F95A/Sample/HelloWorld::onSubscribeResult
  Subscribed and listening for notifications. Press ESC to stop:

  @1023 { {
  "Greeting": "Hello World #1!"
} }
  @2030 { {
  "Greeting": "Hello World #2!"
} }
  @3038 { {
  "Greeting": "Hello World #3!"
} }
  @4045 { {
  "Greeting": "Hello World #4!"
} }
  @5053 { {
  "Greeting": "Hello World #5!"
} }
  @6060 { {
  "Greeting": "Hello World #6!"
} }
/net/ECKI6AF7F95A/Sample/HelloWorld::onUnsubscribeResult: SUCCESS{
  "response": 200,
  "responsestring": "HTTP_CODE_OK",
  "operation": "subscribe",
  "querytimems": 6253,
  "querytimens": 6253077051
}

```

--------------------------------

### Fetch All Log Entries from Movesense Device (Android)

Source: https://www.movesense.com/docs/mobile/android/datalogger_logbook

This example shows how to retrieve a list of all log entries stored on the Movesense device. It sends a GET request to the MDS/Logbook/{serial}/Entries/ resource. The response contains metadata for each log entry.

```java
Mds.builder().build(context).get("suunto://" + movesenseSerial + "/Mem/Logbook/Entries/",
                        null, new MdsResponseListener() {
                            @Override
                            public void onSuccess(String data) {
                            }

                            @Override
                            public void onError(MdsException error) {
                            }
                        });
```

--------------------------------

### wbcmd GET Operation Example

Source: https://www.movesense.com/docs/esw/tools

An example showcasing the GET operation using wbcmd. This operation is used to retrieve data from a specified resource path on the Movesense sensor. It includes common options like timeout and path.

```bash
wbcmd --port COM4 --path /resources/Sensors/Acc --op GET
```

--------------------------------

### Setting up a Movesense Project

Source: https://www.movesense.com/docs/esw/getting_started

Instructions for initializing a Git repository, adding the Movesense device library as a submodule, copying a sample application, and compiling the project.

```APIDOC
## Setting up a Movesense Project

### 1. Create git repository

```bash
$ mkdir myproject
$ cd myproject
$ git init
```

### 2. Add submodule

```bash
$ git submodule add git@bitbucket.org:movesense/movesense-device-lib.git movesense-device-lib --depth 1 --force
```

### 3. Copy plain application sample

```bash
$ cp -R movesense-device-lib/samples/plain_app/* ./ 
# Or for mingw:
$ cp movesense-device-lib/samples/plain_app/* ./ -R
```

### 4. Compile

  1. Create and enter build directory:
     ```bash
     $ mkdir builddir
     $ cd builddir
     ```
  2. Generate ninja files:
     ```bash
     $ cmake -G "Ninja" -DCMAKE_TOOLCHAIN_FILE=../movesense-device-lib/MovesenseCoreLib/toolchain/gcc-nrf52.cmake -DMOVESENSE_CORE_LIBRARY=../movesense-device-lib/MovesenseCoreLib ../ -DCMAKE_BUILD_TYPE=Debug ../
     ```
  3. Run ninja to build DFU and hex files:
     ```bash
     $ ninja
     ```

### 5. Test

- Run `ninja dfupkg` to create a zip file for updating Movesense sensor firmware via your phone (DFU).
- Alternatively, run `ninja pkgs` to create both DFU and hex files for flashing the sensor using a Jig.

### 6. Project Ready

Your project is now ready for development.
```

--------------------------------

### Create Build Folder and Navigate Inside

Source: https://www.movesense.com/docs/esw/getting_started

Creates a build directory within the Movesense library folder and navigates into it. This directory will contain the build artifacts.

```shell
cd /movesense
mkdir myBuild
cd myBuild
```

--------------------------------

### Initialize Git Repository

Source: https://www.movesense.com/docs/esw/getting_started

Commands to create a new directory, navigate into it, and initialize a Git repository for a new project.

```bash
mkdir myproject
cd myproject
git init
```

--------------------------------

### Copy Plain Application Sample

Source: https://www.movesense.com/docs/esw_1.9/getting_started

Copies the plain application sample files into the main project directory. An alternative command is provided for mingw environments.

```bash
cp -R movesense-device-lib/samples/plain_app/* ./

```

```bash
cp movesense-device-lib/samples/plain_app/* ./ -R

```

--------------------------------

### GET /Sample/Test

Source: https://www.movesense.com/docs/esw_1.9/getting_started

This endpoint is a test function that always returns the value 1.

```APIDOC
## GET /Sample/Test

### Description
Test function returning always 1.

### Method
GET

### Endpoint
/Sample/Test

### Parameters

### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **Value** (integer) - Some description

#### Response Example
```json
{
  "Value": 1
}
```
```

--------------------------------

### Hello World API

Source: https://www.movesense.com/docs/esw_1.9/sample_applications

This section covers the 'Hello World' sample application. It includes a GET operation to print a 'Hello World!' message and a subscription option for periodic notifications.

```APIDOC
## GET /Sample/HelloWorld

### Description
Prints the "Hello World!" string only once when requested.

### Method
GET

### Endpoint
/Sample/HelloWorld

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
wbcmd --port COMx --path /Sample/HelloWorld --op GET
```

### Response
#### Success Response (200)
- **response** (integer) - HTTP response code.
- **responsestring** (string) - HTTP response status string.
- **operation** (string) - The operation performed.
- **uri** (string) - The URI of the resource.
- **content** (object) - The payload of the response.
  - **Greeting** (string) - The "Hello World!" message.
- **querytimems** (integer) - Query time in milliseconds.
- **querytimens** (integer) - Query time in nanoseconds.

#### Response Example
```json
{
  "response": 200,
  "responsestring": "HTTP_CODE_OK",
  "operation": "get",
  "uri": "/net/ECKI6AF7F95A/Sample/HelloWorld",
  "content": {
    "Greeting": "Hello World!"
  },
  "querytimems": 28,
  "querytimens": 28776889
}
```

## SUBSCRIBE /Sample/HelloWorld

### Description
Subscribes to periodic notifications of "Hello World #n!" strings, where 'n' is automatically incremented.

### Method
SUBSCRIBE

### Endpoint
/Sample/HelloWorld

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
wbcmd --port COMx --path /Sample/HelloWorld --op Subscribe
```

### Response
#### Success Response (200)
- **response** (integer) - HTTP response code.
- **responsestring** (string) - HTTP response status string.
- **operation** (string) - The operation performed.
- **querytimems** (integer) - Query time in milliseconds.
- **querytimens** (integer) - Query time in nanoseconds.

#### Response Example
```json
{
  "response": 200,
  "responsestring": "HTTP_CODE_OK",
  "operation": "subscribe",
  "querytimems": 6253,
  "querytimens": 6253077051
}
```

### Notifications
- **@timestamp** (integer) - Timestamp of the notification.
- **content** (object) - The payload of the notification.
  - **Greeting** (string) - The "Hello World #n!" message.

### Notification Example
```
@1023 {
  "Greeting": "Hello World #1!"
}
@2030 {
  "Greeting": "Hello World #2!"
}
```
```

--------------------------------

### /Info API GET Request

Source: https://www.movesense.com/docs/esw_1.9/api_reference

Illustrates how to retrieve device and platform information from a Movesense sensor using the /Info API via a GET request. This API is recommended as a starting point for understanding the device's hardware and software status.

```bash
/Info : GET

```

--------------------------------

### Get Single Temperature Measurement (Shell)

Source: https://www.movesense.com/docs/esw_1.9/api_reference

Performs a single temperature measurement using the wbcmd tool. Requires wbcmd to be installed and configured.

```bash
$ wbcmd --port COM13 --path Meas/Temp --op GET

Response:
{
  "response": 200,
  "responsestring": "HTTP_CODE_OK",
  "operation": "get",
  "uri": "/net/ECKI63B33D2B/Meas/Temp",
  "content": {
    "Timestamp": 4424140,
    "Measurement": 296.64999389648438
  },
  "querytimems": 79,
  "querytimens": 79661821
}

```

--------------------------------

### Hello World: CMake Build Configuration

Source: https://www.movesense.com/docs/esw/sample_applications

Build command for the Hello World application using CMake. Specifies the build system, Movesense core library path, toolchain file, and build type.

```bash
cmake -G Ninja -DMOVESENSE_CORE_LIBRARY=../MovesenseCoreLib/ -DCMAKE_TOOLCHAIN_FILE=../MovesenseCoreLib/toolchain/gcc-nrf52.cmake -DCMAKE_BUILD_TYPE=Release ../samples/hello_world_app

```

--------------------------------

### Get Temperature Information (Shell)

Source: https://www.movesense.com/docs/esw_1.9/api_reference

Retrieves information about the temperature sensor (range and accuracy) using the wbcmd tool. Requires wbcmd to be installed and configured.

```bash
$ wbcmd --port COM13 --path Meas/Temp/Info --op GET

Response:
{
  "response": 200,
  "responsestring": "HTTP_CODE_OK",
  "operation": "get",
  "uri": "/net/ECKI63B33D2B/Meas/Temp/Info",
  "content": {
    "Min": 233,
    "Max": 398,
    "Accuracy": 1
  },
  "querytimems": 31,
  "querytimens": 31975028
}

```

--------------------------------

### DataLogger State API

Source: https://www.movesense.com/docs/mobile/android/datalogger_logbook

Control the state of the DataLogger service, including starting and stopping the logging process.

```APIDOC
## PUT /Mem/DataLogger/State/

### Description
Control the state of the DataLogger service. Setting the state to 3 starts logging.

### Method
PUT

### Endpoint
`/Mem/DataLogger/State/`

### Parameters
#### Request Body
- **newState** (integer) - Required - The desired new state for the DataLogger. Use 3 to start logging.

### Request Example
```json
{
    "newState": 3
}
```

### Response
#### Success Response (200)
- **Content** (integer) - The current state of the DataLogger. A value of 3 indicates logging is active.

#### Response Example
```json
{"Content": 3}
```
```

--------------------------------

### Build One Wire App with CMake

Source: https://www.movesense.com/docs/esw/sample_applications

This snippet demonstrates the CMake command for building the One Wire sample application. Similar to Jumpmeter, it configures the build environment using Ninja, specifying paths to the Movesense Core Library and the toolchain file.

```bash
cmake -G Ninja -DMOVESENSE_CORE_LIBRARY=../MovesenseCoreLib/ -DCMAKE_TOOLCHAIN_FILE=../MovesenseCoreLib/toolchain/gcc-nrf52.cmake -DCMAKE_BUILD_TYPE=Release ../samples/1wire_app

```

--------------------------------

### Creating API YAML file

Source: https://www.movesense.com/docs/esw/getting_started

Guidelines for creating an API YAML file, referencing sample applications and Movesense API structure. Includes an example `Test.yaml`.

```APIDOC
## Creating API YAML file

The first step is to create the API YAML file. You can refer to the sample applications and the Movesense API documentation for guidance. The following example demonstrates an API with a single path and a GET function that returns a predefined value.

### `Test.yaml`

```yaml
swagger: '2.0'

info:
  version: "0.0.0"
  title: Test API
  description: |
    Description
  termsOfService: http://xxxxx.com/
  contact:
    name: ABCD Company
    url: http://COMPANYABCD.com

# Paths
paths:
  /Sample/Test:
    get:
      description: |
        Test function returning always 1
      responses:
        200:
          schema:
            description: New value
            $ref: '#/definitions/Test'

definitions:
  Test:
    required:
      - Value
    properties:
      Value:
        description: Some description
        type: integer
        format: uint8
```
```

--------------------------------

### Implement HTTP Request Handlers (C++)

Source: https://www.movesense.com/docs/esw_1.9/whiteboard

Implement virtual functions to handle incoming HTTP requests (GET, PUT, POST, DELETE). The default implementation returns 'Not Implemented'. Example shows handling GET requests for different resource IDs.

```cpp
virtual void onGetRequest(const Request& rRequest, const ParameterList& rParameters);
virtual void onPutRequest(const Request& rRequest, const ParameterList& rParameters);
virtual void onPostRequest(const Request& rRequest, const ParameterList& rParameters);
virtual void onDeleteRequest(const Request& rRequest, const ParameterList& rParameters);
```

```cpp
void TestService::onGetRequest(const whiteboard::Request& request,
                                     const whiteboard::ParameterList& parameters)
{
    // in order to save ROM, this could also be:
    // ASSERT(mModuleState == WB_RES::ModuleStateValues::STARTED);
    if (mModuleState != WB_RES::ModuleStateValues::STARTED)
    {
        return returnResult(request, wb::HTTP_CODE_SERVICE_UNAVAILABLE);
    }

    switch (request.getResourceId().localResourceId)
    {
    case WB_RES::LOCAL::SAMPLE_TEST1::LID:
    {
        WB_RES::Test test;
        test.value = 1;
        return returnResult(request, whiteboard::HTTP_CODE_OK, ResponseOptions::Empty, test);
    }
    break;

    case WB_RES::LOCAL::SAMPLE_TEST2::LID:
    {
        WB_RES::Test test;
        test.value = 2;
        return returnResult(request, whiteboard::HTTP_CODE_OK, ResponseOptions::Empty, test);
    }
    break;

    default:
        return returnResult(request, whiteboard::HTTP_CODE_NOT_FOUND);
    }
}
```

--------------------------------

### Run Movesense Build Environment Docker (Windows)

Source: https://www.movesense.com/docs/esw/getting_started

Starts the Movesense build environment Docker container on Windows. It mounts the specified folder containing the movesense-device-lib to /movesense within the container. Use forward slashes for the path separator.

```shell
docker run -it --rm -v <Path to movesense-device-lib folder>:/movesense:delegated movesense/sensor-build-env:2.2
```

--------------------------------

### Subscribe to Temperature Changes (Shell)

Source: https://www.movesense.com/docs/esw_1.9/api_reference

Subscribes to continuous temperature updates using the wbcmd tool. Displays example notification format. Requires wbcmd to be installed and configured.

```bash
$ wbcmd --port COM13 --path Meas/Temp --op SUBSCRIBE

Example notification:
  @1070 { {
  "Timestamp": 12125,
  "Measurement": 297.33749389648438
} }

```

--------------------------------

### Get EEPROM Memory Layout Info

Source: https://www.movesense.com/docs/esw/data_storage

Retrieves information about the memory layout of an EEPROM chip on the Movesense module. This is achieved by issuing GET requests to '/Component/Eeprom/{EepromIndex}/Info', incrementing 'EepromIndex' starting from 0 until an error is returned. The response includes the total size of the EEPROM chip in bytes.

```http
GET /Component/Eeprom/0/Info HTTP/1.1
Host: your_sensor_host
```

--------------------------------

### Start Module - C++

Source: https://www.movesense.com/docs/esw/whiteboard

The startModule method is invoked by the startup service provider to enable module operation. It can access configuration data that becomes available after initialization. The method returns true upon successful startup, false otherwise. It also acquires timing resources and updates the module state.

```cpp
bool TestService::startModule()
{
    // read configuration that is accessible after initialization
    readDefaultConfig();
    acquireTimingResources();
    mModuleState = WB_RES::ModuleStateValues::STARTED;
    return true;
}
```

--------------------------------

### Initialize Git Repository for Movesense Project

Source: https://www.movesense.com/docs/esw_1.9/getting_started

Initializes a new Git repository and sets up the Movesense device library as a submodule.

```bash
mkdir myproject
cd myproject
git init
git submodule add git@bitbucket.org:movesense/movesense-device-lib.git movesense-device-lib --depth 1 --force

```

--------------------------------

### Start Module Implementation (C++)

Source: https://www.movesense.com/docs/esw_1.9/whiteboard

Implements the startModule method to begin module operation. It reads configuration, acquires timing resources, and sets the module state to STARTED. This method is called after initialization is complete.

```cpp
bool TestService::startModule()
{
    // read configuration that is accessible after initialization
    readDefaultConfig();
    acquireTimingResources();
    mModuleState = WB_RES::ModuleStateValues::STARTED;
    return true;
}

```

--------------------------------

### Info API endpoint

Source: https://www.movesense.com/docs/esw/api_reference

Provides GET requests to retrieve information about the Movesense device and its platform. This API is recommended as a starting point for understanding the hardware, serial number, application name, and module states.

```http
/Info : GET
```

--------------------------------

### MDS REST API - Basic Operations

Source: https://www.movesense.com/docs/mobile/android/main

This section covers the basic RESTful operations (GET, PUT, POST, DELETE) provided by the MDS library to interact with services on Movesense devices.

```APIDOC
## MDS REST API - Basic Operations

### Description
Perform standard RESTful operations (GET, PUT, POST, DELETE) on Movesense devices. These methods allow you to send requests to specific URIs and receive responses or errors via a callback.

### Method
`get(@NonNull String uri, String contract, MdsResponseListener callback)`
`put(@NonNull String uri, String contract, MdsResponseListener callback)`
`post(@NonNull String uri, String contract, MdsResponseListener callback)`
`delete(@NonNull String uri, String contract, MdsResponseListener callback)`

### Endpoint
`[uri]` - The specific endpoint URI on the Movesense device.

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
- **contract** (String) - A JSON string containing the outgoing data and URI for the request.

### Request Example
```java
// Example for a POST request:
String uri = "/System/Debug/Loopback";
String contract = "{\"data\": \"Hello Movesense!\"}";
mds.post(uri, contract, new MdsResponseListener() {
    @Override
    public void onSuccess(String data) {
        // Handle success
    }

    @Override
    public void onError(MdsException error) {
        // Handle error
    }
});
```

### Response
#### Success Response (onSuccess)
- **data** (String) - The response from the device as a JSON string.

#### Error Response (onError)
- **error** (MdsException) - An object containing error details.

### Callback Interface: MdsResponseListener
```java
public interface MdsResponseListener {
    void onSuccess(String data);
    void onError(MdsException error);
}
```
```

--------------------------------

### Create Build Directory for Sensor Simulator

Source: https://www.movesense.com/docs/esw/getting_started

Creates and navigates into a build directory specifically for compiling Movesense software for the Sensor Simulator.

```shell
cd movesense-device-lib
mkdir simuBuild
cd simuBuild
```

--------------------------------

### Start and Stop BLE Scan for Movesense Devices (Java)

Source: https://www.movesense.com/docs/mobile/android/main

This code handles the initiation and termination of a BLE scan to discover Movesense devices. It manages UI elements like buttons and updates a list with scan results. The scan filters for devices whose names start with 'Movesense'. It requires RxJava for subscriptions and Android's BLE APIs.

```java
    Subscription mScanSubscription;
    public void onScanClicked(View view) {
        findViewById(R.id.buttonScan).setVisibility(View.GONE);
        findViewById(R.id.buttonScanStop).setVisibility(View.VISIBLE);

        // Start with empty list
        mScanResArrayList.clear();
        mScanResArrayAdapter.notifyDataSetChanged();

        mScanSubscription = getBleClient().scanBleDevices(
                new ScanSettings.Builder() 
                        // .setScanMode(ScanSettings.SCAN_MODE_LOW_LATENCY) // change if needed
                        // .setCallbackType(ScanSettings.CALLBACK_TYPE_ALL_MATCHES) // change if needed
                        .build() 
                // add filters if needed
        )
                .subscribe(
                        scanResult -> {
                            Log.d(LOG_TAG,"scanResult: " + scanResult);

                            // Process scan result here. filter movesense devices.
                            if (scanResult.getBleDevice()!=null &&
                                    scanResult.getBleDevice().getName() != null &&
                                    scanResult.getBleDevice().getName().startsWith("Movesense")) {

                                // replace if exists already, add otherwise
                                MyScanResult msr = new MyScanResult(scanResult);
                                if (mScanResArrayList.contains(msr))
                                    mScanResArrayList.set(mScanResArrayList.indexOf(msr), msr);
                                else
                                    mScanResArrayList.add(0, msr);

                                mScanResArrayAdapter.notifyDataSetChanged();
                            }
                        },
                        throwable -> {
                            Log.e(LOG_TAG,"scan error: " + throwable);
                            // Handle an error here.

                            // Re-enable scan buttons, just like with ScanStop
                            onScanStopClicked(null);
                        }
                );
    }

    public void onScanStopClicked(View view) {
        if (mScanSubscription != null)
        {
            mScanSubscription.unsubscribe();
            mScanSubscription = null;
        }

        findViewById(R.id.buttonScan).setVisibility(View.VISIBLE);
        findViewById(R.id.buttonScanStop).setVisibility(View.GONE);
    }

```

--------------------------------

### Build Firmware and Packages

Source: https://www.movesense.com/docs/esw/getting_started

Builds the firmware and update packages using the Ninja build system. The output includes Movesense_combined.hex and DFU packages.

```shell
ninja pkgs
```

--------------------------------

### Construct a Launchable Module Instance (C++)

Source: https://www.movesense.com/docs/esw/whiteboard

This code demonstrates the construction of a launchable module instance, setting its name and associating it with an execution context. Execution contexts define threads and Whiteboard's event-based framework for inter-context communication.

```cpp
#include <app_execution_contexts/resources.h>

const char* const TestService::LAUNCHABLE_NAME = "TestSvc";

TestService::TestService()
    : LaunchableModule(LAUNCHABLE_NAME, WB_EXEC_CTX_APPLICATION)
{}

```

--------------------------------

### Read MAX3000x Chipset Register using wbcmd

Source: https://www.movesense.com/docs/esw_1.9/api_reference

Reads a specific register value from the MAX3000x chipset using the 'wbcmd' tool. This example specifies the port, path, data type, and the register address (as an operand) for the GET operation. It includes a sample JSON response.

```bash
wbcmd --port COM10 --path Component/MAX3000x/Register --opdatatype uint8 --opdata 10

```

--------------------------------

### Build One Wire Temperature App with CMake

Source: https://www.movesense.com/docs/esw/sample_applications

This command builds the One Wire Temperature sample application using CMake. It sets up the build process with Ninja, pointing to the necessary Movesense Core Library and toolchain configuration files.

```bash
cmake -G Ninja -DMOVESENSE_CORE_LIBRARY=../MovesenseCoreLib/ -DCMAKE_TOOLCHAIN_FILE=../MovesenseCoreLib/toolchain/gcc-nrf52.cmake -DCMAKE_BUILD_TYPE=Release ../samples/1wire_temperature_app

```

--------------------------------

### Build Plain Sample CMake Configuration

Source: https://www.movesense.com/docs/esw/sample_applications

Provides the CMake command to build the Plain sample application. It specifies the build generator (Ninja), the path to the Movesense Core Library, the toolchain file for the GCC ARM Embedded Toolchain, and the build type as Release.

```bash
cmake -G Ninja -DMOVESENSE_CORE_LIBRARY=../MovesenseCoreLib/ -DCMAKE_TOOLCHAIN_FILE=../MovesenseCoreLib/toolchain/gcc-nrf52.cmake -DCMAKE_BUILD_TYPE=Release ../samples/plain_app

```

--------------------------------

### Start Logging (Android)

Source: https://www.movesense.com/docs/mobile/android/datalogger_logbook

Initiates the data logging process on the Movesense sensor by sending a PUT request to the '/Mem/DataLogger/State/' resource with a new state value of 3 (DATALOGGER_LOGGING). This is handled using the Movesense Core Library's MdsClient.

```java
Mds.builder().build(context).put("suunto://" + movesenseSerial + "/Mem/DataLogger/State/",
                    "{\"newState\":3}", new MdsResponseListener() {
                        @Override
                        public void onSuccess(String data) {
                        }
                        @Override
                        public void onError(MdsException error) {
                        }
                    });
```

--------------------------------

### Define Test API Path

Source: https://www.movesense.com/docs/esw_1.9/getting_started

This section defines a GET endpoint for '/Sample/Test' which returns a 'Test' object. The 'Test' object has a 'Value' property of type uint8. This configuration is typically used in an API definition file like app_root.yaml.

```yaml
paths:
  /Sample/Test:
    get:
      description: |
        Test function returning always 1
      responses:
        200:
          schema:
            description: New value
            $ref: '#/definitions/Test'

definitions:
  Test:
    required:
      - Value
    properties:
      Value:
        description: Some description
        type: integer
        format: uint8
```

--------------------------------

### Flash Movesense Sensor with nrfjprog (Windows/Mac)

Source: https://www.movesense.com/docs/esw/getting_started

Command to flash the Movesense sensor using the updated bootloader on Windows and Mac. This command merges bootloader, softdevice, and application into a single hex file. Ensure you are in the shared build folder when executing.

```bash
nrfjprog -f nrf52 --sectoranduicrerase --program Movesense_combined.hex --reset
```

--------------------------------

### Get MAX3000x Chipset Version using wbcmd

Source: https://www.movesense.com/docs/esw_1.9/api_reference

Retrieves the chipset version of the AFE (Analog Front End) for the MAX3000x sensor using the 'wbcmd' command-line tool. This command targets a specific resource path to query the version information. The example shows the command and a typical JSON response.

```bash
wbcmd --port COM10 --path Component/MAX3000x/Version

```

--------------------------------

### Run Movesense Build Environment Docker (Linux/Mac)

Source: https://www.movesense.com/docs/esw/getting_started

Starts the Movesense build environment Docker container on Linux or Mac. It mounts the current directory to /movesense within the container, providing access to the library files.

```shell
docker run -it --rm -v `pwd`:/movesense:delegated movesense/sensor-build-env:2.2
```

--------------------------------

### Implement HTTP Request Handlers (C++)

Source: https://www.movesense.com/docs/esw/whiteboard

Implement virtual callback functions to handle incoming HTTP requests (GET, PUT, POST, DELETE). The default implementation returns 'Not Implemented'. Provides an example of overriding `onGetRequest` to handle specific resource IDs.

```cpp
virtual void onGetRequest(const Request& rRequest, const ParameterList& rParameters);
virtual void onPutRequest(const Request& rRequest, const ParameterList& rParameters);
virtual void onPostRequest(const Request& rRequest, const ParameterList& rParameters);
virtual void onDeleteRequest(const Request& rRequest, const ParameterList& rParameters);
```

```cpp
void TestService::onGetRequest(const whiteboard::Request& request,
                                     const whiteboard::ParameterList& parameters)
{
    if (mModuleState != WB_RES::ModuleStateValues::STARTED)
    {
        return returnResult(request, wb::HTTP_CODE_SERVICE_UNAVAILABLE);
    }

    switch (request.getResourceId().localResourceId)
    {
    case WB_RES::LOCAL::SAMPLE_TEST1::LID:
    {
        WB_RES::Test test;
        test.value = 1;
        return returnResult(request, whiteboard::HTTP_CODE_OK, ResponseOptions::Empty, test);
    }
    break;

    case WB_RES::LOCAL::SAMPLE_TEST2::LID:
    {
        WB_RES::Test test;
        test.value = 2;
        return returnResult(request, whiteboard::HTTP_CODE_OK, ResponseOptions::Empty, test);
    }
    break;

    default:
        return returnResult(request, whiteboard::HTTP_CODE_NOT_FOUND);
    }
}
```

--------------------------------

### HELLO Command

Source: https://www.movesense.com/docs/esw/gatt_sensordata_protocol

Details the HELLO command (Command ID: 0), used for initial communication and retrieving sensor information.

```APIDOC
## HELLO Command

### Description
The HELLO command is used to initiate communication and retrieve basic information about the sensor.

### Method
POST

### Endpoint
`/websites/movesense` (Assumed context, actual characteristic used is GATT write)

### Parameters
#### Command Packet
- **Command code**: `0` (uint8)
- **Reference code**: `uint8` (Client-defined)
- **Command specific data**: None

### Request Example
```json
{
  "command_code": 0,
  "reference_code": 10
}
```

### Response
#### Success Response (Response code = 1)
- **Response code**: `1` (uint8)
- **Reference code**: `uint8` (Matches the command's reference code)
- **Status code**: `uint16` (little endian) - HTTP status code.
- **Data**: Contains sensor information if the firmware supports GSP.
  - **Protocol version**: `uint8` - Should be `1`.
  - **Serial number**: `utf8` ('\0' terminated)
  - **ProductName**: `utf8` ('\0' terminated)
  - **DFU-MAC address**: `utf8` ('\0' terminated)
  - **AppName**: `utf8` ('\0' terminated)
  - **AppVersion**: `utf8` ('\0' terminated)

#### Response Example (if data is present)
```json
{
  "response_code": 1,
  "reference_code": 10,
  "status_code": 200,
  "data": {
    "protocol_version": 1,
    "serial_number": "MVS-SN12345\0",
    "ProductName": "MySensor\0",
    "DFU-MAC_address": "AA:BB:CC:DD:EE:FF\0",
    "AppName": "movesense-firmware.bin\0",
    "AppVersion": "1.2.3\0"
  }
}
```

#### Response Example (if no GSP support in firmware)
```json
{
  "response_code": 1,
  "reference_code": 10,
  "status_code": 200,
  "data": null
}
```
```

--------------------------------

### Query Movesense Device Info Service

Source: https://www.movesense.com/docs/mobile/android/main

Retrieves information from the '/Info' service of a connected Movesense device. It constructs a URI using the device's serial number and performs a GET request using the mMds.get method. The response is displayed in an AlertDialog.

```java
    @Override
    public void onItemClick(AdapterView<?> parent, View view, int position, long id) {
        if (position < 0 || position >= mScanResArrayList.size())
            return;

        MyScanResult device = mScanResArrayList.get(position);
        if (!device.isConnected()) {
            return;
        }

        String uri = SCHEME_PREFIX + device.connectedSerial + "/Info";
        final Context ctx = this;
        mMds.get(uri, null, new MdsResponseListener() {
            @Override
            public void onSuccess(String s) {
                Log.i(LOG_TAG, "Device " + device.connectedSerial + " /info request succesful: " + s);
                // Display info in alert dialog
                AlertDialog.Builder builder = new AlertDialog.Builder(ctx);
                builder.setTitle("Device info:")
                        .setMessage(s)
                        .show();
            }

            @Override
            public void onError(MdsException e) {
                Log.e(LOG_TAG, "Device " + device.connectedSerial + " /info returned error: " + e);
            }
        });
    }

```

--------------------------------

### Build Jumpmeter App with CMake

Source: https://www.movesense.com/docs/esw/sample_applications

This snippet shows the CMake command to build the Jumpmeter sample application. It specifies the build system (Ninja), the path to the Movesense Core Library, the toolchain file, and the build type (Release).

```bash
cmake -G Ninja -DMOVESENSE_CORE_LIBRARY=../MovesenseCoreLib/ -DCMAKE_TOOLCHAIN_FILE=../MovesenseCoreLib/toolchain/gcc-nrf52.cmake -DCMAKE_BUILD_TYPE=Release ../samples/jumpmeter_app

```

--------------------------------

### Remove All Stored Entries from Movesense Device Memory (Android)

Source: https://www.movesense.com/docs/mobile/android/datalogger_logbook

This example demonstrates how to clear all stored log entries from the Movesense device's memory. It sends a DELETE request to the /{serial}/Mem/Logbook/Entries/ resource. Use with caution as this action is irreversible.

```java
Mds.builder().build(context).delete("suunto://" + movesenseSerial + "/Mem/Logbook/Entries/",
                        null, new MdsResponseListener() {
                            @Override
                            public void onSuccess(String data) {
                            }

                            @Override
                            public void onError(MdsException error) {
                            }
                        });
```

--------------------------------

### ResourceClient Inheritance

Source: https://www.movesense.com/docs/esw/whiteboard

Demonstrates how a client class should inherit from the ResourceClient base class to access services provided by modules. Inheritance from LaunchableModule is optional for startup initialization.

```cpp
#include <whiteboard/ResourceClient.h>

class TestClient FINAL : private whiteboard::ResourceClient

```
Tokens:
Raw