Class OctoPrintClient

Hierarchy

OctoPrintClient

Index

Constructors

constructor

Methods

ping

Constructors

constructor

new OctoPrintClient(url: string, apiKey: string): OctoPrintClient
Parameters
- url: string
- apiKey: string
Returns OctoPrintClient
- Defined in index.ts:17

Properties

apiKey

apiKey: string = ""

baseUrl

baseUrl: string = ""

connectPrinter

connectPrinter: ((this: OctoPrintClient, port: string, baudrate: number, printerProfile: string, save?: boolean, autoconnect?: boolean) => Promise<HttpResponse<undefined>>) = General.connectPrinter

Type declaration

- (this: OctoPrintClient, port: string, baudrate: number, printerProfile: string, save?: boolean, autoconnect?: boolean): Promise<HttpResponse<undefined>>
- Instructs OctoPrint to connect or, if already connected, reconnect to the printer. Additional parameters are:
  
  Returns
  Parameters
  - this: OctoPrintClient
  - port: string
    
    Optional, specific port to connect to. If not set the current portPreference will be used, or if no preference is available auto detection will be attempted.
  - baudrate: number
    
    Optional, specific baudrate to connect with. If not set the current baudratePreference will be used, or if no preference is available auto detection will be attempted.
  - printerProfile: string
    
    Optional, specific printer profile to use for connection. If not set the current default printer profile will be used.
  - save: boolean = false
    
    Optional, whether to save the request’s port and baudrate settings as new preferences. Defaults to false if not set.
  - autoconnect: boolean = false
    
    Optional, whether to automatically connect to the printer on OctoPrint’s startup in the future. If not set no changes will be made to the current configuration.
  Returns Promise<HttpResponse<undefined>>

connection

connection: ((this: OctoPrintClient) => Promise<HttpResponse<ConnectionSettings>>) = General.connection

Type declaration

- (this: OctoPrintClient): Promise<HttpResponse<ConnectionSettings>>
- Parameters
  - this: OctoPrintClient
  Returns Promise<HttpResponse<ConnectionSettings>>

copyFile

copyFile: ((this: OctoPrintClient, location: "local" | "sdcard", src: string, dest: string) => Promise<HttpResponse<CopyFileResponse>>) = Files.copyFile

Type declaration

- (this: OctoPrintClient, location: "local" | "sdcard", src: string, dest: string): Promise<HttpResponse<CopyFileResponse>>
- Returns
  Parameters
  - this: OctoPrintClient
  - location: "local" | "sdcard"
  - src: string
  - dest: string
  Returns Promise<HttpResponse<CopyFileResponse>>

`Protected` delete

delete: (<T>(this: OctoPrintClient, url: string, bodyArgs?: {}) => Promise<HttpResponse<T>>) = del

Type declaration

- <T>(this: OctoPrintClient, url: string, bodyArgs?: {}): Promise<HttpResponse<T>>
- Type Parameters
  - T
  Parameters
  - this: OctoPrintClient
  - url: string
  - Optional bodyArgs: {}
  Returns Promise<HttpResponse<T>>

deleteFile

deleteFile: ((this: OctoPrintClient, location: "local" | "sdcard", filepath: string) => Promise<HttpResponse<undefined>>) = Files.deleteFile

Type declaration

- (this: OctoPrintClient, location: "local" | "sdcard", filepath: string): Promise<HttpResponse<undefined>>
- Returns
  Parameters
  - this: OctoPrintClient
  - location: "local" | "sdcard"
  - filepath: string
    
    Should start with local/... or sdcard/...
  Returns Promise<HttpResponse<undefined>>

disconnectPrinter

disconnectPrinter: ((this: OctoPrintClient) => Promise<HttpResponse<undefined>>) = General.disconnectPrinter

Type declaration

- (this: OctoPrintClient): Promise<HttpResponse<undefined>>
- Instructs OctoPrint to disconnect from the printer.
  
  Returns
  Parameters
  - this: OctoPrintClient
  Returns Promise<HttpResponse<undefined>>

feedrate

feedrate: ((this: OctoPrintClient, feedrate: number) => Promise<HttpResponse<unknown>>) = Printer.feedrate

Type declaration

- (this: OctoPrintClient, feedrate: number): Promise<HttpResponse<unknown>>
- Parameters
  - this: OctoPrintClient
  - feedrate: number
  Returns Promise<HttpResponse<unknown>>

files

files: ((this: OctoPrintClient) => Promise<HttpResponse<GetFilesResponse>>) = Files.files

Type declaration

- (this: OctoPrintClient): Promise<HttpResponse<GetFilesResponse>>
- Retrieve information regarding all files currently available and regarding the disk space still available locally in the system. The results are cached for performance reasons. If you want to override the cache, supply the query parameter force and set it to true. Note that while printing a refresh/override of the cache for files stored on the printer’s SD card is disabled due to bandwidth restrictions on the serial interface. By default only returns the files and folders in the root directory. If the query parameter recursive is provided and set to true, returns all files and folders.
  
  Returns
  Parameters
  - this: OctoPrintClient
  Returns Promise<HttpResponse<GetFilesResponse>>

`Protected` get

get: (<T>(this: OctoPrintClient, url: string, bodyArgs?: {}) => Promise<HttpResponse<T>>) = get

Type declaration

- <T>(this: OctoPrintClient, url: string, bodyArgs?: {}): Promise<HttpResponse<T>>
- Type Parameters
  - T
  Parameters
  - this: OctoPrintClient
  - url: string
  - Optional bodyArgs: {}
  Returns Promise<HttpResponse<T>>

home

home: ((this: OctoPrintClient, axes: HOME) => Promise<HttpResponse<undefined>>) = Printer.home

Type declaration

- (this: OctoPrintClient, axes: HOME): Promise<HttpResponse<undefined>>
- Parameters
  - this: OctoPrintClient
  - axes: HOME
  Returns Promise<HttpResponse<undefined>>

jobCommand

jobCommand: ((this: OctoPrintClient, cmd: JobCommands) => Promise<HttpResponse<undefined>>) = Job.jobCommand

Type declaration

- (this: OctoPrintClient, cmd: JobCommands): Promise<HttpResponse<undefined>>
- Parameters
  - this: OctoPrintClient
  - cmd: JobCommands
  Returns Promise<HttpResponse<undefined>>

jobInformation

jobInformation: ((this: OctoPrintClient) => Promise<HttpResponse<JobInformation>>) = Job.jobInformation

Type declaration

- (this: OctoPrintClient): Promise<HttpResponse<JobInformation>>
- Parameters
  - this: OctoPrintClient
  Returns Promise<HttpResponse<JobInformation>>

jog

jog: ((this: OctoPrintClient, x?: number, y?: number, z?: number, absolute?: boolean, speed?: number) => Promise<HttpResponse<unknown>>) = Printer.jog

Type declaration

- (this: OctoPrintClient, x?: number, y?: number, z?: number, absolute?: boolean, speed?: number): Promise<HttpResponse<unknown>>
- Parameters
  - this: OctoPrintClient
  - Optional x: number
  - Optional y: number
  - Optional z: number
  - Optional absolute: boolean
  - Optional speed: number
  Returns Promise<HttpResponse<unknown>>

languages

languages: ((this: OctoPrintClient) => Promise<HttpResponse<LanguagesResponse>>) = Languages.languages

Type declaration

- (this: OctoPrintClient): Promise<HttpResponse<LanguagesResponse>>
- Parameters
  - this: OctoPrintClient
  Returns Promise<HttpResponse<LanguagesResponse>>

moveFile

moveFile: ((this: OctoPrintClient, location: "local" | "sdcard", src: string, dest: string) => Promise<HttpResponse<MoveFileResponse>>) = Files.moveFile

Type declaration

- (this: OctoPrintClient, location: "local" | "sdcard", src: string, dest: string): Promise<HttpResponse<MoveFileResponse>>
- Returns
  Parameters
  - this: OctoPrintClient
  - location: "local" | "sdcard"
  - src: string
  - dest: string
  Returns Promise<HttpResponse<MoveFileResponse>>

`Protected` post

post: (<T>(this: OctoPrintClient, url: string, bodyArgs?: {}) => Promise<HttpResponse<T>>) = post

Type declaration

- <T>(this: OctoPrintClient, url: string, bodyArgs?: {}): Promise<HttpResponse<T>>
- Type Parameters
  - T
  Parameters
  - this: OctoPrintClient
  - url: string
  - Optional bodyArgs: {}
  Returns Promise<HttpResponse<T>>

print

print: ((this: OctoPrintClient, file: string) => Promise<HttpResponse<unknown>>) = Files.print

Type declaration

- (this: OctoPrintClient, file: string): Promise<HttpResponse<unknown>>
- Initiate printing of named file.
  
  Returns
  Parameters
  - this: OctoPrintClient
  - file: string
  Returns Promise<HttpResponse<unknown>>

server

server: ((this: OctoPrintClient) => Promise<HttpResponse<ServerInformation>>) = General.server

Type declaration

- (this: OctoPrintClient): Promise<HttpResponse<ServerInformation>>
- Parameters
  - this: OctoPrintClient
  Returns Promise<HttpResponse<ServerInformation>>

sliceFile

sliceFile: ((this: OctoPrintClient, filepath: string, args: SliceRequest) => Promise<HttpResponse<SliceFileResponse>>) = Files.sliceFile

Type declaration

- (this: OctoPrintClient, filepath: string, args: SliceRequest): Promise<HttpResponse<SliceFileResponse>>
- Returns
  Parameters
  - this: OctoPrintClient
  - filepath: string
    
    Should start with local/... or sdcard/...
  - args: SliceRequest
  Returns Promise<HttpResponse<SliceFileResponse>>

status

status: ((this: OctoPrintClient) => Promise<HttpResponse<PrinterStatus>>) = Printer.status

Type declaration

- (this: OctoPrintClient): Promise<HttpResponse<PrinterStatus>>
- Parameters
  - this: OctoPrintClient
  Returns Promise<HttpResponse<PrinterStatus>>

uploadGcode

uploadGcode: ((this: OctoPrintClient, location: "local" | "sdcard", filepath: string, gcode: string) => Promise<HttpResponse<UploadFileToLocalResponse>>) = Files.uploadGcode

Type declaration

- (this: OctoPrintClient, location: "local" | "sdcard", filepath: string, gcode: string): Promise<HttpResponse<UploadFileToLocalResponse>>
- Returns
  Parameters
  - this: OctoPrintClient
  - location: "local" | "sdcard"
  - filepath: string
  - gcode: string
  Returns Promise<HttpResponse<UploadFileToLocalResponse>>

version

version: ((this: OctoPrintClient) => Promise<HttpResponse<VersionInformation>>) = General.version

Type declaration

- (this: OctoPrintClient): Promise<HttpResponse<VersionInformation>>
- Parameters
  - this: OctoPrintClient
  Returns Promise<HttpResponse<VersionInformation>>

Methods

ping

ping(): string
Returns string
- Defined in index.ts:22

Class OctoPrintClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

url: string

apiKey: string

Returns OctoPrintClient

Properties

apiKey

baseUrl

connectPrinter

Type declaration

Returns

Parameters

this: OctoPrintClient

port: string

baudrate: number

printerProfile: string

save: boolean = false

autoconnect: boolean = false

Returns Promise<HttpResponse<undefined>>

connection

Type declaration

Parameters

this: OctoPrintClient

Returns Promise<HttpResponse<ConnectionSettings>>

copyFile

Type declaration

Returns

Parameters

this: OctoPrintClient

location: "local" | "sdcard"

src: string

dest: string

Returns Promise<HttpResponse<CopyFileResponse>>

Protected delete

Type declaration

Type Parameters

T

Parameters

this: OctoPrintClient

url: string

Optional bodyArgs: {}

Returns Promise<HttpResponse<T>>

deleteFile

Type declaration

Returns

Parameters

this: OctoPrintClient

location: "local" | "sdcard"

filepath: string

Returns Promise<HttpResponse<undefined>>

disconnectPrinter

Type declaration

Returns

Parameters

this: OctoPrintClient

Returns Promise<HttpResponse<undefined>>

feedrate

Type declaration

Parameters

this: OctoPrintClient

feedrate: number

Returns Promise<HttpResponse<unknown>>

files

Type declaration

Returns

Parameters

this: OctoPrintClient

Returns Promise<HttpResponse<GetFilesResponse>>

Protected get

Type declaration

Type Parameters

T

Parameters

`Protected` delete

`Optional` bodyArgs: {}

`Protected` get

`Optional` bodyArgs: {}

`Optional` x: number

`Optional` y: number

`Optional` z: number

`Optional` absolute: boolean

`Optional` speed: number

`Protected` post

`Optional` bodyArgs: {}