OctoPrintClient

class OctoPrintClient([options])

Instantiates a new instance of the client library. Note that by default there’s always an instance registered globally called OctoPrint.

Arguments:
OctoPrintClient.options

The client library instance’s options. The following keys are currently supported:

apikey
The API Key to use for requests against the OctoPrint API. Should usually be the anonymous UI API Key provided on the socket.
baseurl
The base URL of the OctoPrint API
locale
The locale to set in X-Locale headers on API requests. Useful for API endpoints that might return localized content.
OctoPrintClient.plugins

Registration of client library components provided by plugins.

OctoPrint plugins should always register their client classes here using their plugin identifier as key via OctoPrintClient.registerPluginComponent().

Note

The registration mechanism has changed slightly with OctoPrint 1.3.2 due to an otherwise unsolvable issue with allowing multiple clients to exist concurrently and still keeping the existing architecture intact.

The old mechanism works fine as long as you are only planning to offer your plugin client implementation on the default client instance OctoPrint, however if you also want to support additional clients you’ll need to use the implementation and registration approach as described below.

Example:

(function (global, factory) {
    if (typeof define === "function" && define.amd) {
        define(["OctoPrintClient"], factory);
    } else {
        factory(window.OctoPrintClient);
    }
})(window || this, function(OctoPrintClient) {
    var MyPluginClient = function(base) {
        this.base = base;
    };

    MyPluginClient.prototype.someFunction = function() {
        // do something
    };

    // further define API

    OctoPrintClient.registerPluginComponent("myplugin", MyPluginClient);
    return MyPluginClient;
});
OctoPrintClient.getBaseUrl()

Returns the canonical base URL to use for OctoPrint’s API. Uses the current value of OctoPrint.options.baseurl. If that doesn’t end in a /, a trailing / will be appended to the URL before the result is returned.

Returns string:The base url to use to access OctoPrint’s API.
OctoPrintClient.getRequestHeaders(additional)

Generates a dictionary of HTTP headers to use for API requests against OctoPrint with all necessary headers and any additionally provided ones.

At the moment this entails setting the X-Api-Key header based on the current value of OctoPrint.options.apikey at a minimum.

Arguments:
  • additional (object) – Additional headers to add to the request.
Returns object:

HTTP headers to use for requests.

OctoPrintClient.ajax(method, url, opts)

Performs an AJAX request against the OctoPrint API, utilizing jQuery’s own ajax function.

The HTTP method to use may be defined through opts.method or - if that is not provided – through the method parameter. If neither is available, GET will be used.

The URL to perform the request against may be defined through opts.url or – if that is not provided – through the url parameter. If neither is available, an empty string will be used (plain base URL). If the URL starts with http:// or https:// it will be used directly. Otherwise the return value of OctoPrint.getBaseUrl() will be prepended.

As headers everything returned by OctoPrint.getRequestHeaders() will be used. Additional headers to set may be defined by providing them through opts.headers.

If opts.dataType is set, it will be used for setting the corresponding option on the jQuery ajax call, otherwise json will be used.

Anything provided in the opts parameter will also be passed on to the jQuery ajax call.

Arguments:
  • method (string) – The HTTP method to use for the request (optional)
  • url (string) – The URL to perform the request against (optional)
  • opts (object) – Additional options to use for the request, see above for details (optional)
Returns Promise:
 

A jQuery Promise for the request’s response

OctoPrintClient.ajaxWithData(method, url, data, opts)

Performs an AJAX request against the OctoPrint API, including the provided data in the body of the request.

Utilizes OctoPrint.ajax(), see that for more details.

Arguments:
  • method (string) – The HTTP method to use for the request (optional)
  • url (string) – The URL to perform the request against (optional)
  • data (object) – The data to send in the request body (optional)
  • opts (object) – Additional options to use for the request (optional)
Returns Promise:
 

A jQuery Promise for the request’s response

OctoPrintClient.get(url, opts)

Performs a GET request against url.

Example:

OctoPrint.get("api/version")
    .done(function(response) {
        console.log("API:", response.api, "Server:", response.server);
    });
Arguments:
  • url (string) – URL against which to make the request, relative to base url or absolute
  • opts (object) – Additional options for the request
Returns Promise:
 

A jQuery Promise for the request’s response

OctoPrintClient.getWithQuery(url, data, opts)

Performs a GET request against url using the provided data as URL query.

Example:

// this should perform a GET of "api/timelapse?unrendered=true"
OctoPrint.getWithQuery("api/timelapse", {"unrendered": true});
Arguments:
  • url (string) – URL against which to make the request, relative to base url or absolute
  • data (object) – An object containing the key/value pairs of the query data OR a string representation of the query
  • opts (object) – Additional options for the request
Returns Promise:
 

A jQuery Promise for the request’s response

OctoPrintClient.post(url, data, opts)

Performs a POST request against url using the provided data as request body.

Example:

var url = OctoPrint.getBlueprintUrl("myplugin") + "endpoint";
OctoPrint.post(url, "a whole lot of data", {"contentType": "application/octet-stream"})
    .done(function(response) {
        // do something with the response
    });
Arguments:
  • url (string) – URL against which to make the request, relative to base url or absolute
  • data (string) – Data to post as request body
  • opts (object) – Additional options for the request
  • opts – Additional options for the request
Returns Promise:
 

A jQuery Promise for the request’s response

OctoPrintClient.postJson(url, data, opts)

Performs a POST request against url using the provided data object as request body after serializing it to JSON.

Example:

var url = OctoPrint.getBlueprintUrl("myplugin") + "endpoint";
OctoPrint.postJson(url, {"someKey": "someValue"})
    .done(function(response) {
        // do something with the response
    });
Arguments:
  • url (string) – URL against which to make the request, relative to base url or absolute
  • data (object) – Data to post as request body after serialization to JSON
  • opts (object) – Additional options for the request
Returns Promise:
 

A jQuery Promise for the request’s response

OctoPrintClient.put(url, data, opts)

Performs PUT request against url using the provided data as request body.

See OctoPrint.post() for details.

OctoPrintClient.putJson(url, data, opts)

Performs PUT request against url using the provided data as request body after serializing it to JSON.

See OctoPrint.postJson() for details.

OctoPrintClient.patch(url, data, opts)

Performs PATCH request against url using the provided data as request body.

See OctoPrint.post() for details.

OctoPrintClient.patchJson(url, data, opts)

Performs PATCH request against url using the provided data as request body after serializing it to JSON.

See OctoPrint.postJson() for details.

OctoPrintClient.delete(url, opts)

Performs a DELETE request against url.

Arguments:
  • url (string) – URL against which to make the request, relative to base url or absolute
  • opts (object) – Additional options for the request
Returns Promise:
 

A jQuery Promise for the request’s response

OctoPrintClient.download(url, opts)

Downloads a file from url, returning the response body as data type text.

Use this if you need to download a file from the server in order to process it further in the client. The response body returned on successful completion of the returned jQuery Promise will contain the requested file as raw string/binary.

Arguments:
  • url (string) – URL to download
  • opts (object) – Additional options for the request
Returns Promise:
 

A jQuery Promise for the request’s response

OctoPrintClient.upload(url, file, filename, additional)

Uploads a file to url using a multipart/form-data POST request.

file should be either of

  • a jQuery element pointing at a file input of the page of which the first File instance will be used,
  • a string usable as selector to address a file input of the page of which the first File instance will be used or
  • a File instance

If filename is provided, the file upload data will contain its value as file name for the upload, otherwise the name property from the File instance.

The function will return a jQuery Promise which will also be notified on the upload progress with an object containing the following properties:

loaded
The number of bytes already uploaded
total
The total number of bytes to upload

This can be used to populate progress bars or other types of progress visualization.

It is important to note that contrary to all the other request methods in this module, OctoPrint.upload is implemented using XMLHttpRequest directly instead of relying on jQuery’s ajax function. It still tries to replicate its behaviour on the returned jQuery Promise however, meaning that the resolve and reject methods will be called with (data, textStatus, request) and (request, textStatus, error) parameters respectively.

Additional form elements for the POSTed form can be supplied through the additional parameters. This should be an object of key/value pairs that are set as field name and value on the FormData object that will be used in the request.

Example:

Uploading a file to some/path on the blueprint of plugin myplugin, from a file input element, updating a label with the current upload progress.

var fileInput = $("#my-file-input");
var progressOutput = $("#progress-output");

OctoPrint.upload(OctoPrint.getBlueprintUrl("myplugin") + "some/path",
                 fileInput,
                 "myfilename.dat",
                 {"somekey": "somevalue"})
    .progress(function(data) {
        if (data.total) {
            var percentage = Math.round(data.loaded * 100 / data.total);
            if (percentage || percentage == 0) {
                progressOutput.text(percentage + "%");
                return;
            }
        }
        progressOutput.text("");
    })
    .done(function(response, textStatus, request) {
        progressOutput.text("Uploaded!");
    });
Arguments:
  • url (string) – URL to which to POST the upload, relative to base url or absolute
  • file (object) – The file to object, see description for details
  • filename (string) – An optional file name to use for the upload
  • additional (object) – An optional object of additional key/value pairs to set on the uploaded form data
OctoPrintClient.issueCommand(url, command, payload, opts)

Issues a command against an OctoPrint command API endpoint.

OctoPrint contains various API endpoints which follow a specific pattern: The payload of the request body is a JSON object which contains at least one property command and depending on the provided command additional parameters as further properties for the command. See the Issue a file command for an example of an API endpoint following this pattern.

Using this function sending commands to such API endpoints becomes a trivial task. The function expects the url of the endpoint, the command to send, and optional payload and additional opts.

The function will take care of wrapping the command and the payload into one JSON object and POSTing that to the endpoint with the correct JSON content type.

Example:

var url = OctoPrint.getBlueprintUrl("myplugin") + "myendpoint";
OctoPrint.issueCommand(url, "mycommand", {"someParameter": "someValue",
                                          "someOtherParameter": "someOtherValue"})
    .done(function(response) {
        // do something with the response
    });
Arguments:
  • url (string) – The URL to POST the command to
  • command (string) – The command to issue
  • payload (object) – Additional payload data for the command
  • opts (object) – Additional options for the request
Returns Promise:
 

A jQuery Promise for the request’s response

OctoPrintClient.getSimpleApiUrl(plugin)

Returns the proper URL for the endpoint of a SimpleApiPlugin, based on the plugin identifier.

Example:

// prints "api/plugin/myplugin"
console.log(OctoPrint.getSimpleApiUrl("myplugin")
Arguments:
  • plugin (string) – The identifier of the plugin for which to return the URL
Returns string:

The URL to use as endpoint

OctoPrintClient.simpleApiGet(plugin, opts)

Performs a GET request against the endpoint of a SimpleApiPlugin with identifier plugin.

OctoPrint.simpleApiGet("myplugin")
    .done(function(response) {
        // do something with the response
    });
Arguments:
  • plugin (string) – The identifier of the plugin
  • opts (object) – Additional options for the request
Returns Promise:
 

A jQuery Promise for the request’s response

OctoPrintClient.simpleApiCommand(plugin, command, payload, opts)

Performs the API command command against the endpoint of a SimpleApiPlugin with identifier plugin, including the optional payload.

Example:

OctoPrint.simpleApiCommand("myplugin", "mycommand", {"someParameter": "someValue",
                                                     "otherParameter": "otherValue"})
    .done(function(response) {
        // do something with the response
    });
Arguments:
  • plugin (string) – The identifier of the plugin
  • command (string) – The command to issue
  • payload (object) – Additional payload data for the command
  • opts (object) – Additional options for the request
Returns Promise:
 

A jQuery Promise for the request’s response

OctoPrintClient.getBlueprintUrl(plugin)

Returns the proper base URL for blueprint endpoints of a BlueprintPlugin with identifier plugin.

Example:

// prints "plugin/myplugin/"
console.log(OctoPrint.getBlueprintUrl("myplugin"));
OctoPrintClient.createRejectedDeferred()

Static method.

Shortcut for creating a rejected jQuery Deferred.

OctoPrintClient.createCustomException(name)

Static method.

Creates a custom exception class. name may be either a function in which case it will be used as constructor for the new exception class, or a string, in which case a constructor with proper name, message and stack attributes will be created. The class hierarchy will be propery setup to subclass Error.

Example:

MyCustomException = OctoPrintClient.createCustomException("MyCustomException");
throw new MyCustomException("Something went horribly wrong!");
OctoPrintClient.registerPluginComponent(identifier, clientClass)

Static method.

Registers the plugin client component clientClass under the name identifier on the OctoPrintClient.plugins registry.

clientClass must have a constructor that follows the signature ClientClass(base) and in which it sets the attribute base on the instance to:

var MyPluginClient = function(base) {
    this.base = base;
}

Each OctoPrintClient() will create its own instance of registered plugin classes and make them available under OctoPrintClient.plugins. It will inject itself into those instances in order to allow plugin clients to access its functionality via this.base:

MyPluginClient.prototype.doSomething = function(data, opts) {
    return this.base.simpleApiCommand("myplugin", "doSomething", data, opts);
};
Arguments:
  • identifier (string) – The identifier of the plugin for which clientClass is the client
  • clientClass (class) – The client class to register. Constructor must follow the signature ClientClass(base) where base will be assigned to the instance as this.base and be the OctoPrintClient() instance to use for API calls etc via this.base.
class OctoPrintClient.InvalidArgumentError()

Exception to use when functions are called with invalid arguments.