WebSupervisor API

API change history

Unit commands

Allows commanding of the engine.

Try it

Request

Request URL

Request parameters

  • string

    Unique unit identifier

Request headers

  • (optional)
    string

    Application token

  • (optional)
    string

    Basic authorization

  • (optional)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

List of all available commands:

  • start

  • stop

  • faultReset

  • changeMcb

    • toggle Mains circuit breaker

  • changeGcb

    • toggle Genset circuit breaker

  • sensorButton

    • supported only by special branch of controllers

  • timerButton

    • supported only by special branch of controllers

  • changeMode

    • requires attribute "mode" - string representing mode e.g. off, man, aut, test
      • for list of available modes for particular controller model check the value 49424e2b-1009-471c-b8e3-3e84e9c16159

  • userButton

    • requires attribute "index" - number to identify user button (1-32)
    • requires attribute "action" - string representing action ("start", "stop", "toggle", "pulse")

  • remoteSwitch

    • requires attribute "index" - number to identify remote switch (1-8)
    • requires attribute "action" - string representing action ("start", "stop")

  • extValue

    • requires attribute "index" - number to identify external value (1-4)
    • requires attribute "value" - numerical value written to selected external value

  • setTimer

    • requires attribute "index" - number to identify timer (1-2)
    • requires attribute "action" - json object with timer settings

  • changeSetpoint

    • requires attribute "guid" - guid to identify setpoint
    • requires attribute "value" - numerical value or string written to selected setpoint, string values are case sensitive

JSON object for timer settings:

  • requires attribute "mode" - string representing timer settings ("Off", "Once", "Daily", "Weekly", "Monthly", "MonthlyDays", "Period")
    • for "mode": "Off"
      • no attribute
    • for "mode": "Once"
      • requires attribute "from" - number, timer first occurance, UNIX epoch time in miliseconds
      • requires attribute "duration" - number, timer duration in minutes
    • for "mode": "Daily"
      • requires attribute "from" - number, timer first occurance, UNIX epoch time in miliseconds
      • requires attribute "duration" - number, timer duration in minutes
      • requires attribute "setupDaily" - json object with timer settings
        • requires attribute "dayRepeat" - number, repeat every x. day
        • requires attribute "dayWeekend" - string, how to handle weekends ("Included", "Except", "nextDayAfter")
    • for "mode": "Weekly"
      • requires attribute "from" - number, timer first occurance, UNIX epoch time in miliseconds
      • requires attribute "duration" - number, timer duration in minutes
      • requires attribute "setupWeekly" - json object with timer settings
        • requires attribute "weekRepeat" - number, repeat every x. week
        • requires attribute "weekDays" - string array, select day/s when execute ("Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday")
    • for "mode": "Monthly"
      • requires attribute "from" - number, timer first occurance, UNIX epoch time in miliseconds
      • requires attribute "duration" - number, timer duration in minutes
      • requires attribute "setupMonthly" - json object with timer settings
        • requires attribute "monthRepeat" - number, repeat every x. month
        • requires attribute "dayInMonth" - number, repeat every x. day in month
    • for "mode": "MonthlyDays"
      • requires attribute "from" - number, timer first occurance, UNIX epoch time in miliseconds
      • requires attribute "duration" - number, timer duration in minutes
      • requires attribute "setupMonthlyDays" - json object with timer settings
        • requires attribute "monthRepeat" - number, repeat every x. month
        • requires attribute "weekInMonth" - number, repeat every x. week in month
        • requires attribute "weekDays" - string array, select day/s when execute ("Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday")
    • for "mode": "Period"
      • requires attribute "from" - number, timer first occurance, UNIX epoch time in miliseconds
      • requires attribute "duration" - number, timer duration in minutes
      • requires attribute "setupPeriod" - json object with timer settings
        • requires attribute "minutesRepeat" - number, repeat every x minutes

{
    "command": "start"
}
{
  "example": "{\n    \"command\": \"changeMode\",\n    \"mode\": \"man\"\n}"
}
{
    "command": "changeMode",
    "mode": "man"
}
{
  "example": "{\n    \"command\": \"changeMode\",\n    \"mode\": \"man\"\n}"
}
{
    "command": "userButton",
    "index": 2,
    "action": "start"
}
{
  "example": "{\n    \"command\": \"changeMode\",\n    \"mode\": \"man\"\n}"
}
{
    "command": "setTimer",
    "index": 1,
    "action": {
        "mode": "off"
    }
}
{
  "example": "{\n    \"command\": \"changeMode\",\n    \"mode\": \"man\"\n}"
}
{
    "command": "setTimer",
    "index": 1,
    "action": {
        "mode": "once",
        "from": 1601286038000,
        "duration": 60
    }
}
{
  "example": "{\n    \"command\": \"changeMode\",\n    \"mode\": \"man\"\n}"
}
{
    "command": "setTimer",
    "index": 1,
    "action": {
        "mode": "weekly",
        "from": 1601286038000,
        "duration": 60,
        "setupWeekly": {
            "weekRepeat": 2,
            "weekDays": ["Monday", "Wednesday", "Friday", "Sunday"]
        }
    }
}
{
  "example": "{\n    \"command\": \"changeMode\",\n    \"mode\": \"man\"\n}"
}
{
    "command": "extValue",
    "index": 3,
    "value": 100
}
{
  "example": "{\n    \"command\": \"changeMode\",\n    \"mode\": \"man\"\n}"
}
{
    "command": "changeSetpoint",
    "guid": "7b2ae258-65a8-40dd-bb42-5455753679f9",
    "value": "MyController"
}
{
  "example": "{\n    \"command\": \"changeMode\",\n    \"mode\": \"man\"\n}"
}

Responses

200 OK

Command was successfully sent.

Representations

400 Bad Request

Response when incorrect unitGuid is provided

Representations

401 Unauthorized

Response when incorrect token or username + password is provided

Representations

Code samples

@ECHO OFF

curl -v -X POST "https://api.websupervisor.net/v1/units/{unitGuid}/command"
-H "Token: "
-H "Authorization: "
-H "Content-Type: Start"
-H "Comap-Key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Token", "");
            client.DefaultRequestHeaders.Add("Authorization", "");
            client.DefaultRequestHeaders.Add("Comap-Key", "{subscription key}");

            var uri = "https://api.websupervisor.net/v1/units/{unitGuid}/command?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.websupervisor.net/v1/units/{unitGuid}/command");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Token", "");
            request.setHeader("Authorization", "");
            request.setHeader("Content-Type", "Start");
            request.setHeader("Comap-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://api.websupervisor.net/v1/units/{unitGuid}/command?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Token","");
                xhrObj.setRequestHeader("Authorization","");
                xhrObj.setRequestHeader("Content-Type","Start");
                xhrObj.setRequestHeader("Comap-Key","{subscription key}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.websupervisor.net/v1/units/{unitGuid}/command";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"Token"];
    [_request setValue:@"" forHTTPHeaderField:@"Authorization"];
    [_request setValue:@"Start" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Comap-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.websupervisor.net/v1/units/{unitGuid}/command');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Token' => '',
    'Authorization' => '',
    'Content-Type' => 'Start',
    'Comap-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Token': '',
    'Authorization': '',
    'Content-Type': 'Start',
    'Comap-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.websupervisor.net')
    conn.request("POST", "/v1/units/{unitGuid}/command?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Token': '',
    'Authorization': '',
    'Content-Type': 'Start',
    'Comap-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.websupervisor.net')
    conn.request("POST", "/v1/units/{unitGuid}/command?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.websupervisor.net/v1/units/{unitGuid}/command')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Token'] = ''
# Request headers
request['Authorization'] = ''
# Request headers
request['Content-Type'] = 'Start'
# Request headers
request['Comap-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body