Requirements:

  1. Android application with version 3.0.88 or higher.
  2. Windows application with version 3.1.301 or higher.

Setup:

To start the built-in HTTP server this sensor configuration has to be set on the device:

The authCredentials property is optional, if you do not wish to use authentication for the server, then you do not have to set this property.

Without the authcredentials the configuration looks like this:

Usage:

The server is running with HTTP on the 8181 port and receives POST or GET requests on the /api/sensor/event endpoint, and if the authCredentials property is set in the configuration then uses basic-auth for security (For example http://192.168.1.120:8181/api/sensor/event).

GET method:

A GET request can be sent to the receiver device to this endpoint in this format:
http://<device ip>:8181/api/sensor/event?event=anyEvent&id=anyId&value=anyValue

POST method:

A POST request can be sent to receiver device to this endpoint
http://<device ip>:8181/api/sensor/event

In this method a request body has to be sent to endpoint that has to be a JSON that matches this format:
{“id”:”sensorId”,”event”:”anyEvent”, “value”: “anyValue”}

Authentication

If the authCredentials property is set in the configuration then the incoming request has to have a valid Authorization header with the same username and password in basic-auth format.

Server response codes:

  • 200: Everything is OK the server handled the response.
  • 400: The received body’s format is not valid.
  • 401: Bad Authorization data.
  • 500: Internal server error.

Example of valid request in Postman:

Post

If the authCredentials property is set in the configuration you need to set your Authorization header (Basic Auth format) in Postman:

Get

If the authCredentials property is set in the configuration you need to set your Authorization header (Basic Auth format) in Postman:

ABOUT WALLBOARD

Leverage Wallboard's powerful suite of tools to create, automate, and manage dynamic digital signage that your audience will remember.

Ready to Get Started?

Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.