Smarther - v2.0

API change history

An API to easily get informations and control your Smarther
Check API change log

Set Chronothermostat Status

Operation used to set the status of a chronothermostat.

Required scope: comfort.write

Try it

Request URL

Request parameters

Name Type Description Values
plantId string

Format - uuid. The id of the plant

moduleId string

Format - uuid. The id of the device

Request headers

Name Type Description
Content-Type (optional) string Media type of the body sent to the API.
Ocp-Apim-Subscription-Key string Subscription key which provides access to this API. Found in your Profile.
Authorization string OpenID Connect id token obtained from ELIOT - Azure AD B2C - OpenID Connect. Supported grant types: Authorization code, Implicit.

Request body

Body of the Set Chronothermostat Status request

{
  "function": "heating",
  "mode": "automatic",
  "setPoint": {
    "value": "string",
    "unit": "C"
  },
  "programs": [
    {
      "number": 0
    }
  ],
  "activationTime": "string"
}
{
  "type": "object",
  "properties": {
    "function": {
      "type": "string",
      "enum": [
        "heating",
        "cooling"
      ],
      "description": "Desired thermostat function"
    },
    "mode": {
      "type": "string",
      "enum": [
        "automatic",
        "manual",
        "boost",
        "off",
        "protection"
      ],
      "description": "Desired thermostat working mode"
    },
    "setPoint": {
      "type": "object",
      "description": "Desired setpoint temperature (Celsius scale): required parameter for manual mode",
      "properties": {
        "value": {
          "type": "string",
          "minimum": 3,
          "maximum": 40
        },
        "unit": {
          "type": "string",
          "enum": [
            "C"
          ]
        }
      }
    },
    "programs": {
      "type": "array",
      "description": "Number of program to be set: required parameter for automatic mode",
      "items": {
        "type": "object",
        "properties": {
          "number": {
            "type": "integer",
            "minimum": 0,
            "maximum": 11
          }
        }
      },
      "maxItems": 1
    },
    "activationTime": {
      "type": "string",
      "pattern": "[0-9]{4}(-[0-9]{1,2}){2}T[0-9]{2}(:[0-9]{2}){2}(/[0-9]{4}(-[0-9]{1,2}){2}T[0-9]{2}(:[0-9]{2}){2})?",
      "description": "Date and time (format YYYY-MM-DDThh:mm:ss) to which new working mode will be maintained. For boost mode, duration is limited to 30, 60 or 90 minutes, indicating starting (current) and final date and time. Required parameter for boost mode, optional for manual, off and protection modes"
    }
  },
  "required": [
    "function",
    "mode"
  ]
}

Response 200

Response 400

Bad request: something is probably wrong in your request body or headers.

{
  "statusCode": 400,
  "message": "Bad request"
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "integer",
      "example": 400,
      "description": "Error code"
    },
    "message": {
      "type": "string",
      "example": "Bad request",
      "description": "Error message"
    }
  }
}

Response 401

Unauthorized: user is not authorized to access the requested resource.

{
  "statusCode": 401,
  "message": "Unauthorized"
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "integer",
      "example": 401,
      "description": "Error code"
    },
    "message": {
      "type": "string",
      "example": "Unauthorized",
      "description": "Error message"
    }
  }
}

Response 404

Resource not found/Gateway offline: something is probably wrong in your request URL or your thermostat is temporary disconnected from the network.

{
  "statusCode": 404,
  "message": "Resource not found"
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "integer",
      "example": 404,
      "description": "Error code"
    },
    "message": {
      "type": "string",
      "example": "Resource not found",
      "description": "Error message"
    }
  }
}

Response 408

Request timeout

{
  "statusCode": 408,
  "message": "Request timeout"
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "integer",
      "example": 408,
      "description": "Error code"
    },
    "message": {
      "type": "string",
      "example": "Request timeout",
      "description": "Error message"
    }
  }
}

Response 430

Official application password expired: password used in the Thermostat official app is expired.

{
  "statusCode": 430,
  "message": "Wrong input parameters"
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "integer",
      "example": 430,
      "description": "Error code"
    },
    "message": {
      "type": "string",
      "example": "Wrong input parameters",
      "description": "Error message"
    }
  }
}

Response 469

Official application password expired: password used in the Thermostat official app is expired.

{
  "statusCode": 469,
  "message": "Password used in the Thermostat official app is expired. Please renew it through the official application."
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "integer",
      "example": 469,
      "description": "Error code"
    },
    "message": {
      "type": "string",
      "example": "Password used in the Thermostat official app is expired. Please renew it through the official application.",
      "description": "Error message"
    }
  }
}

Response 470

Official application terms and conditions expired: terms and conditions for Thermostat official app are expired.

{
  "statusCode": 470,
  "message": "Terms and conditions for Thermostat official app are expired. Please accept them again through the official application."
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "integer",
      "example": 470,
      "description": "Error code"
    },
    "message": {
      "type": "string",
      "example": "Terms and conditions for Thermostat official app are expired. Please accept them again through the official application.",
      "description": "Error message"
    }
  }
}

Response 486

Official application password expired: password used in the Thermostat official app is expired.

{
  "statusCode": 486,
  "message": "Busy visual user interface"
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "integer",
      "example": 486,
      "description": "Error code"
    },
    "message": {
      "type": "string",
      "example": "Busy visual user interface",
      "description": "Error message"
    }
  }
}

Response 500

Server internal error

{
  "statusCode": 500,
  "message": "Server internal error"
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "integer",
      "example": 500,
      "description": "Error code"
    },
    "message": {
      "type": "string",
      "example": "Server internal error",
      "description": "Error message"
    }
  }
}

Code samples

@ECHO OFF

curl -v -X POST "https://api.developer.legrand.com/smarther/v2.0/chronothermostat/thermoregulation/addressLocation/plants/{plantId}/modules/parameter/id/value/{moduleId}"
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
-H "Authorization: {id token}"

--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("Ocp-Apim-Subscription-Key", "{subscription key}");
            client.DefaultRequestHeaders.Add("Authorization", "{id token}");

            var uri = "https://api.developer.legrand.com/smarther/v2.0/chronothermostat/thermoregulation/addressLocation/plants/{plantId}/modules/parameter/id/value/{moduleId}?" + 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.developer.legrand.com/smarther/v2.0/chronothermostat/thermoregulation/addressLocation/plants/{plantId}/modules/parameter/id/value/{moduleId}");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
            request.setHeader("Authorization", "{id token}");


            // 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.developer.legrand.com/smarther/v2.0/chronothermostat/thermoregulation/addressLocation/plants/{plantId}/modules/parameter/id/value/{moduleId}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
                xhrObj.setRequestHeader("Authorization","{id token}");
            },
            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.developer.legrand.com/smarther/v2.0/chronothermostat/thermoregulation/addressLocation/plants/{plantId}/modules/parameter/id/value/{moduleId}";
    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:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    [_request setValue:@"{id token}" forHTTPHeaderField:@"Authorization"];
    // 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.developer.legrand.com/smarther/v2.0/chronothermostat/thermoregulation/addressLocation/plants/{plantId}/modules/parameter/id/value/{moduleId}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
    'Authorization' => '{id token}',
);

$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
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
    'Authorization': '{id token}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.developer.legrand.com')
    conn.request("POST", "/smarther/v2.0/chronothermostat/thermoregulation/addressLocation/plants/{plantId}/modules/parameter/id/value/{moduleId}?%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
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
    'Authorization': '{id token}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.developer.legrand.com')
    conn.request("POST", "/smarther/v2.0/chronothermostat/thermoregulation/addressLocation/plants/{plantId}/modules/parameter/id/value/{moduleId}?%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.developer.legrand.com/smarther/v2.0/chronothermostat/thermoregulation/addressLocation/plants/{plantId}/modules/parameter/id/value/{moduleId}')

request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request headers
request['Authorization'] = '{id token}'
# 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