Octoprint Machine Configuration

The following configuration options of the common machine configuration model apply to Octoprint machines.

Obtaining the API key

  • Navigate to the URL of the machine in a web browser, this should bring up the OctoPrint Settings.

  • Obtain either the global api key or a user bound api key:

    • Click on Api in the left menu and note the Apikey.

    • Click on Access Control, create a new user or note the Apikey of an existing one that has at least STATUS permissions.

Aggregator version 1.4+

Configuration

Data

Description

Required

Configuration

Data

Description

Required

type

OCTOPRINT

The machine's interface type.

url

http://192.168.1.41:5000

The individual machine's interface url.

custom_name

my_octoprint_machine

The custom machine name to be displayed in the Agile MES.

authentication_file_path

secret.txt or JSON string

API key. For files, the path can be absolute or relative to the Aggregator.

mes_id

[1]

The MES instance(s) of your organization.

Octoprint machine example:

{ "type": "OCTOPRINT", "url": "http://192.168.1.41:5000", "custom_name": "my_octoprint_machine", "authentication_file_path": "secret.txt", // contents as shown below without "" "mes_id": [ 1 ] }

OR

{ "type": "OCTOPRINT", "url": "http://192.168.1.41:5000", "custom_name": "my_octoprint_machine", "authentication_file_path": "A0A00B123E454H122BD513FE58B5E9BC", "mes_id": [ 1 ] }

Aggregator version 1.2 - 1.3

Configuration

Data

Description

Required

Configuration

Data

Description

Required

type

OCTOPRINT

The machine's interface type.

url

http://192.168.1.41:5000

The individual machine's interface url.

custom_name

my_octoprint_machine

The custom machine name to be displayed in the Agile MES.

authentication_file_path

secret.txt

File containing API key.

mes_id

[1]

The MES instance(s) of your organization.

umati_server_port

4840+

Umati server port used for internal data transfer. Set if the default port is conflicting with another port on your server.

Octoprint machine example:

{ "type": "OCTOPRINT", "url": "http://192.168.1.41:5000", "custom_name": "my_octoprint_machine", "authentication_file_path": "secret.txt", "mes_id": [ 1 ] }

Secret:

Simply copy the Apikey into a secret.txt file. Set the file name in the authentication_file_path field in your config.json file.

Example content:

Aggregator version 1.1

Configuration

Data

Description

Required

Configuration

Data

Description

Required

type

OCTOPRINT

The machine's interface type.

url

http://192.168.1.41:5000

The individual machine's interface url.

api_key

A0A00B123E454H122BD513FE58B5E9BC

API key.

mes_id

[1]

The MES instance(s) of your organization.

umati_server_port

4840+

Umati server port used for internal data transfer. Set if the default port is conflicting with another port on your server.

X

Octoprint machine example:

Secret:

Directly copy the API key in the config.json field api_key.