OctoPS

OctoPS is a PowerShell Core module for controling and automating one or more OctoPrint servers. This module runs on MacOS and Windows PowerShell Core 6 against OctoPrint server 1.3 or above.

Getting Started

This PowerShell module allows the control of one of more OctoPrint servers. Printers are added before hand by adding the hosts in the module. Printers that are added are stored in the users home folder if on Linux/MacOS and on AppData on Windows.

Adding a host:

Set-OctoPSHost -Name CR-10_01 -Uri https://192.168.1.20 -ApiKey 5DC40C3C5BFB41709AC37D3DA558BA28

Multiple hosts can be added and each is identified with an Id number

PS /Users/carlos/Documents/OctoPS> Get-OctoPSHost

Id Name     Uri                   ApiKey
-- ----     ---                   ------
 1 CR-10_01 https://192.168.1.237 5DC40C3C5BFB41709AC27D3DA558BA18
 2 CR-10_02 https://192.168.1.20/ 5DC40C4C5BFB41709AC45D7DA852BA28

Each cmdlet has its own help information with examples and they can be seen usong the Get-Help cmdlet

Get-Help Publish-OctoPSFile -full

To list all cmdlets in the module you can use the Get-Command cmdlet

Get-Command -Module OctoPS

Example 1

Example script for printing a test calibration cube using the 1st configured host (default)

#######################
# Check printer status
#######################
$printer = Get-OctoPSPrinterState -SkipCertificateCheck
if ($printer.State -eq "Operational") {
    Write-Host "Printer is operational" -ForegroundColor Green
} else {
    Write-Host "Printer not connected" -ForegroundColor Yellow
    Write-Host "Attempting to connect printter" -ForegroundColor Green
    Invoke-OctoPSPrinterConnect -SkipCertificateCheck

    #wait 30 seconds to give enough time for connection. 
    sleep 30
    if ($printer.State -eq "Operational") {
        Write-Host "Printer is operational" -ForegroundColor Green
    } else {
        throw "Printer is not operational and connection attempt failed."
    }

}

######################
# Select file to print
######################
Write-Host "Printing calibration XYZ cube." -ForegroundColor Green
Select-OctoPSFile -SkipCertificateCheck -Location Local -Path xyzCalibration_cube.gcode

################
# Home all axis
################
Write-Host "Homing all axis on printer." -ForegroundColor Green
Invoke-OctoPSHomeAxis -SkipCertificateCheck

###############################
# Set Bed and Tool Temperatures
###############################
Write-Host "Starting to heat bed to 60 degree celcius." -ForegroundColor Green
Set-OctoPSBed -SkipCertificateCheck -TargetTemp 60
Write-Host "Startting to heat tool to 210 degree celcius." -ForegroundColor Green
Set-OctoPSTool -SkipCertificateCheck -TargetTemp 210

################################################################
# Wait for bed to reach temp and wait 3 minutes before printing
################################################################
Write-Host "Waiting for bed to reach temperature." -ForegroundColor Green -NoNewline
while ((Get-OctoPSBed -SkipCertificateCheck).Temperature -lt 60) {
    Write-Host "." -NoNewline -ForegroundColor Green
    sleep 10
}
Write-Host "Bed has reached temperature." -ForegroundColor Green
Write-Host "Waiting 3 minutes for the bed to properly heat." -ForegroundColor Green
sleep 180

#################
# Start printing
#################
Start-OctoPSJob -SkipCertificateCheck

License

• RestSharp Apache 2.0 License
• OctoPS 3-BSD License