OctoPrint Client

The client has been developed as part of a research programme investigating agent-based manufacturing systems. It is isomorphic capable of running on server (Node.js) and client-side (Browser) applications.

Using octoprint-client

To install the package, use the following code. I am aiming to put it onto npm soon.

pnpm install @jamesgopsill/octoprint-client

You can then use in your code:

Typescript / Javascript (ESM)

import { OctoPrintClient } from "@jamesgopsill/octoprint-client"

// Create a new client.
const client = new OctoPrintClient("OCTOPRINT_URL", "API_KEY")

const response = await client.version()
if (response.ok) {
	console.log(response.data)
}

Javascript (CJS)

const octo = require("@jamesgopsill/octoprint-client")

// Create a new client.
const client = new octo.OctoPrintClient("OCTOPRINT_URL", "API_KEY")

const response = await client.version()
if (response.ok) {
	console.log(response.data)
}

Testing

To test the client, we use the OctoPrint docker image and spin up a local instance that the client can interface with. To spin up an instance, you will need docker installed. Then simply cd into the __tests__/octoprint directory and run:

docker-compose up

To create the Octoprint instance that can be accessed at http://localhost.

Client Docs

The docs have been produced using TypeDoc and can be accessed here.

Contributing

We would love to have additional contributors to the project to help us maintain and add functionality to the project.

Support the Project

The project has been supported by the EPSRC-funded Brokering Additive Manufacturing project (EP/V05113X/1). More details on the project can be found at the Design Manufacturing Futures Lab website.

To donate and provide continued support, please go to [TODO].

References

• Brokering Additive Manufacturing

• OctoPrint

• OctoPrint on Docker Hub

• Git autocrlf

• Typed Responses