Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

Obtaining a secret.json file:

Connect to https://print.carbon3d.com/ and login to obtain your secret.json. The secret file should look like this:

Code Block
languagejson
{
  "client_id": "CLIENT_ID",
  "client_secret": "RSA_PRIVATE_KEY"
}

Aggregator version 1.4+

Configuration

Data

Description

Required

type

CARBON3D

The machine's interface type.

url

https://api.carbon3d.com

Carbon3D api base url.

custom_name

my_carbon3d_machine

The custom machine name to be displayed in the Agile MES. Will be read from the machine if unset.

unique_name

3P01CM

The serial number of the machine.

authentication_file_path

./secret.json or

JSON object

Secrets for JWT authentication as provided by Carbon3D. For files, the path can be absolute or relative to the Aggregator.

mes_id

[1]

The MES instance(s) of your organization.

Carbon3D machine example:

Code Block
languagejson
{
  "type": "CARBON3D",
  "url": "https://api.carbon3d.com",
  "custom_name": "my_carbon3d_machine",
  "unique_name": "3P01CM",
  "authentication_file_path": "./secret.json", // contents as shown above
  "mes_id": [
    1
  ]
}

OR

Code Block
languagejson
{
  "type": "CARBON3D",
  "url": "https://api.carbon3d.com",
  "custom_name": "my_carbon3d_machine",
  "unique_name": "3P01CM",
  "authentication_file_path": {
    "client_id": "CLIENT_ID",
    "client_secret": "RSA_PRIVATE_KEY"
  },
  "mes_id": [
    1
  ]
}

Aggregator version 1.2 - 1.3

Configuration

Data

Description

Required

type

CARBON3D

The machine's interface type.

url

https://api.carbon3d.com

Carbon3D api base url.

custom_name

my_carbon3d_machine

The custom machine name to be displayed in the Agile MES. Will be read from the machine if unset.

unique_name

3P01CM

The serial number of the machine.

authentication_file_path

./secret.json

The secret.json for JWT authentication as provided by Carbon3D. For instructions visit Carbon3D.

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.

Carbon3D machine example:

Code Block
languagejson
{
  "type": "CARBON3D",
  "url": "https://api.carbon3d.com",
  "custom_name": "my_carbon3d_machine",
  "unique_name": "3P01CM",
  "authentication_file_path": "./secret.json",
  "mes_id": [
    1
  ]
}

Secret example:

Add the secret file name to the field authentication_file_path in your config.json.

Aggregator version 1.1

Configuration

Data

Description

Required

type

CARBON3D

The machine's interface type.

url

https://api.carbon3d.com

The individual machine's interface url.

custom_name

carb3d

The custom machine name to be displayed in the Agile MES. Will be appended by the machine’s url. Combined length may not be more than 31 characters.

X

unique_name

3P01CM

The serial number of the machine.

path_to_secret

/absolute/path/to/secret.json

The secret.json for JWT authentication as provided by Carbon3D. For instructions visit Carbon3D.

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

Carbon3D machine example:

Code Block
languagejson
{
  "type": "CARBON3D",
  "url": "https://api.carbon3d.com",
  "custom_name": "carb3d",
  "unique_name": "3P01CM",
  "path_to_secret": "/absolute/path/to/secret.json",
  "mes_id": [
    1
  ]
}

Secret example:

Add the secret file name to the field path_to_secret in your config.json.