-
-
Notifications
You must be signed in to change notification settings - Fork 0
JSON RPC
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "add_local_auth",
"params": {
"username": "",
"local_secret": ""
}
}- username
- local_secret
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "add_makerbot_account",
"params": {
"username": "",
"makerbot_token": ""
}
}- username
- makerbot_token
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "authenticate",
"params": {
"access_token": ""
}
}- access_token
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "authorize",
"params": {
"username": "",
"makerbot_token": null,
"local_secret": null,
"chamber_blink": false
}
}- username
- makerbot_token
- local_secret
- chamber_blink
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "clear_authorize",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "deauthorize",
"params": null
}N/A
Gets connected authorized accounts.
{
"jsonrpc": "2.0",
"id": -1,
"method": "get_authorize",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "reauthorize",
"params": {
"username": "",
"makerbot_token": null,
"local_secret": null,
"local_code": null
}
}- username
- makerbot_token
- local_secret
- local_code
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "wifi_fre_authorize",
"params": {
"username": "",
"makerbot_token": null,
"local_secret": null
}
}- username
- makerbot_token
- local_secret
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "get_static_ipv4",
"params": {
"service_path": ""
}
}- service_path
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "set_static_ipv4",
"params": {
"service_path": "",
"ip": null,
"netmask": null,
"gateway": null,
"dns": null,
"use_static": false
}
}- service_path
- ip
- netmask
- gateway
- dns
- use_static
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "wifi_connect",
"params": {
"path": "",
"password": null,
"name": null
}
}- path
- password
- name
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "wifi_disable",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "wifi_disconnect",
"params": {
"path": null
}
}- path
Enables onboard wireless communication hardware
{
"jsonrpc": "2.0",
"id": -1,
"method": "wifi_enable",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "wifi_forget",
"params": {
"path": null
}
}- path
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "wifi_reset",
"params": null
}N/A
Scans for WiFi signals using the machines onboard wireless hardware
{
"jsonrpc": "2.0",
"id": -1,
"method": "wifi_scan",
"params": {
"force_rescan": false
}
}- force_rescan
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "acknowledged",
"params": {
"error_id": -1
}
}- error_id
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "assisted_level",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "bot_maintained",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "bronx_upload",
"params": {
"filepath": "",
"toolhead": -1
}
}- filepath
- toolhead
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "brooklyn_upload",
"params": {
"filepath": "",
"transfer_wait": false
}
}- filepath
- transfer_wait
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "calibrate_z_offset",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "cancel",
"params": {
"force": false
}
}- force
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "clear_all_z_pause",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "clear_queue",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "clear_ssh_id",
"params": {
"filepath": ""
}
}- filepath
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "clear_z_pause_mm",
"params": {
"z_pause_mm": -1
}
}- z_pause_mm
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "close_queue",
"params": null
}N/A
Requests the machine begin the Cool Machine Process.
{
"jsonrpc": "2.0",
"id": -1,
"method": "cool",
"params": {
"ignore_tool_errors": false
}
}- ignore_tool_errors
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "copy_ssh_id",
"params": {
"filepath": ""
}
}- filepath
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "disable_check_build_plate",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "disable_leds",
"params": {
"disable_knob": false,
"disable_chamber": false
}
}- disable_knob
- disable_chamber
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "disable_z_pause",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "download_and_install_firmware",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "drm_print",
"params": {
"layout_id": -1
}
}- layout_id
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "dump_machine_config",
"params": {
"path": ""
}
}- path
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "enable_check_build_plate",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "enable_leds",
"params": {
"enable_knob": false,
"enable_chamber": false
}
}- enable_knob
- enable_chamber
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "enable_z_pause",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "execute_queue",
"params": null
}N/A
prints from an external .makerbot file
{
"jsonrpc": "2.0",
"id": -1,
"method": "external_print",
"params": {
"url": "",
"ensure_build_plate_clear": true
}
}- url: Address of .makerbot file
- ensure_build_plate_clear: Override 'check build plate clear' prompt.
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "firmware_cleanup",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "get_available_z_offset_adjustment",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "get_machine_config",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "get_persistent_statistics",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "get_print_history",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "get_queue_status",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "get_sound_state",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "get_statistics",
"params": null
}N/A
Gets lifetime statistics for the currently installed tool assembly.
{
"jsonrpc": "2.0",
"id": -1,
"method": "get_tool_usage_stats",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "get_z_adjusted_offset",
"params": null
}N/A
Queries the machine for calibration routine availability
{
"jsonrpc": "2.0",
"id": -1,
"method": "has_z_calibration_routine",
"params": null
}N/A
Requests the Home Machine Process execute
{
"jsonrpc": "2.0",
"id": -1,
"method": "home",
"params": {
"axes": {},
"preheat": true
}
}- axes
- preheat
Queries the machine for endstop status
{
"jsonrpc": "2.0",
"id": -1,
"method": "is_endstop_triggered",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "library_print",
"params": {
"layout_id": -1
}
}- layout_id
Requests the Load Filament Machine Process be executed
{
"jsonrpc": "2.0",
"id": -1,
"method": "load_filament",
"params": {
"tool_index": -1,
"temperature_settings": {}
}
}- tool_index
- temperature_settings
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "load_print_tool",
"params": {
"index": -1
}
}- index
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "machine_action_command",
"params": {
"machine_func": "",
"params": {},
"name": null,
"ignore_tool_errors": false
}
}- machine_func
- params
- name
- ignore_tool_errors
Executes a queryable method on the machine.
{
"jsonrpc": "2.0",
"id": -1,
"method": "machine_query_command",
"params": {
"machine_func": "",
"params": {},
"ignore_tool_errors": false
}
}- machine_func
- params
- ignore_tool_errors
{machine_func: "toolhead_ok", params: {index: 0}}{machine_func: "get_tool_uid", params: {index: 0}}{machine_func: "get_tool_id", params: {index: 0}}{machine_func: "get_tool_usage_stats", params: {index: 0, timeout_s: 60}{machine_func: "get_cached_tool_usage_stats", params: {index: 0}}{machine_func: "is_tool_connected", params: {index: 0}}{machine_func: "endstop_triggered", params: {axis: "x"}}{machine_func: "any_heater_above_temp", params: {temperature_c: 215}}{machine_func: "is_initialized", params: {}}{machine_func: "get_temperature", params: {index: 0}}{machine_func: "get_temperature_settings", params: {}}{machine_func: "get_move_buffer_position", params: {}}{machine_func: "get_axes_position", params: {}}{machine_func: "get_filament_presence", params: {index: 0}}{machine_func: "get_toolhead_firmware_version", params: {index: 0}}{machine_func: "get_extrusion_distance_percent", params: {}}{machine_func: "get_heater_progress_percent", params: {}}{machine_func: "get_power_value", params: {rail: ?, value: ?}}{machine_func: "get_current_command_index", params: {}}{machine_func: "sync_state_confirmed", params: {index: 0}}{machine_func: "get_sync_state", params: {index: 0}}
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "machine_query_process",
"params": {
"machine_func": "",
"params": {},
"name": "",
"ignore_tool_errors": false
}
}- machine_func
- params
- name
- ignore_tool_errors
Requests the Manual Level Machine Process execute
{
"jsonrpc": "2.0",
"id": -1,
"method": "manual_level",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "open_queue",
"params": {
"clear": false
}
}- clear
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "park",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "preheat",
"params": {
"temperature_settings": {}
}
}- temperature_settings
Requests the Print Machine Process execute
{
"jsonrpc": "2.0",
"id": -1,
"method": "print",
"params": {
"filepath": "",
"ensure_build_plate_clear": true,
"transfer_wait": true
}
}- filepath
- ensure_build_plate_clear
- transfer_wait
Requests the Print Again Machine Process execute
{
"jsonrpc": "2.0",
"id": -1,
"method": "print_again",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "process_method",
"params": {
"method": "",
"params": {}
}
}- method
- params
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "reset_to_factory",
"params": {
"clear_calibration": false
}
}- clear_calibration
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "run_diagnostics",
"params": {
"tests": {}
}
}- tests
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "set_auto_unload",
"params": {
"unload_case": ""
}
}- unload_case
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "set_toolhead_error_visibility",
"params": {
"error": "",
"ignored": false
}
}- error
- ignored
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "set_z_adjusted_offset",
"params": {
"offset": 0.0
}
}- offset
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "set_z_pause_mm",
"params": {
"z_pause_mm": -1
}
}- z_pause_mm
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "setup_printer",
"params": {
"jump_to_wifi_setup": false
}
}- jump_to_wifi_setup
Toggles the sound state of the machine
{
"jsonrpc": "2.0",
"id": -1,
"method": "toggle_sound",
"params": {
"state": false
}
}- state
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "unload_filament",
"params": {
"tool_index": -1,
"temperature_settings": {}
}
}- tool_index
- temperature_settings
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "wifi_setup",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "wifi_signal_strength",
"params": {
"ssid": "",
"iface": ""
}
}- ssid
- iface
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "yonkers_upload",
"params": {
"filepath": "",
"uid": "",
"index": -1,
"force": false,
"id": -1
}
}- filepath
- uid
- index
- force
- id
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "zip_logs",
"params": {
"zip_path": ""
}
}- zip_path
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "birdwing_list",
"params": {
"path": ""
}
}- path
Requests the machine capture an image with the onboard camera and save a JPG to the specified path.
{
"jsonrpc": "2.0",
"id": -1,
"method": "capture_image",
"params": {
"output_file": ""
}
}- output_file: Storage location on the machine. Recommended path '/home/camera/' as it is accessible from the machine's settings.
Changes the display name of the machine
{
"jsonrpc": "2.0",
"id": -1,
"method": "change_machine_name",
"params": {
"machine_name": ""
}
}- machine_name: New display name for the machine
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "desync_account",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "end_camera_stream",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "expire_thingiverse_credentials",
"params": null
}N/A
Easter Egg
{
"jsonrpc": "2.0",
"id": -1,
"method": "first_contact",
"params": null
}N/A
Gets flags and stats for cloud serivce integration.
{
"jsonrpc": "2.0",
"id": -1,
"method": "get_cloud_services_info",
"params": null
}N/A
{
"jsonrpc": "2.0",
"result": {
"num_authorized": 2,
"lcd_username": null,
"reflector_enabled": true,
"analytics_enabled": true
},
"id": "4"
}(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "get_config",
"params": null
}N/A
Requests current system information.
{
"jsonrpc": "2.0",
"id": -1,
"method": "get_system_information",
"params": null
}N/A
Requests basic introductory information
{
"jsonrpc": "2.0",
"id": -1,
"method": "handshake",
"params": {
"username": null,
"host_version": null
}
}- username
- host_version
Requests network status information
{
"jsonrpc": "2.0",
"id": -1,
"method": "network_state",
"params": null
}N/A
Performs basic network ping on JSON-RPC service
{
"jsonrpc": "2.0",
"id": -1,
"method": "ping",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "register_client_name",
"params": {
"name": ""
}
}- name
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "request_camera_frame",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "request_camera_stream",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "set_analytics_enabled",
"params": {
"enabled": false
}
}- enabled
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "set_reflector_enabled",
"params": {
"enabled": false
}
}- enabled
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "set_thingiverse_credentials",
"params": {
"thingiverse_username": "",
"thingiverse_token": ""
}
}- thingiverse_username
- thingiverse_token
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "sync_account_to_bot",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "update_available_firmware",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "get_init",
"params": {
"file_path": "",
"file_id": ""
}
}- file_path
- file_id
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "put_init",
"params": {
"file_path": "",
"file_id": ""
}
}- file_path
- file_id
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "put_term",
"params": {
"file_id": "",
"length": -1,
"crc": 0
}
}- file_id
- length
- crc
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "get_unique_identifiers",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "get_spool_info",
"params": {
"bay_index": -1
}
}- bay_index
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "get_tracked_stats",
"params": null
}N/A
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "put_raw",
"params": {
"file_id": "",
"block": "",
"block_size": -1
}
}- file_id
- block
- block_size
(Enter Description Here)
{
"jsonrpc": "2.0",
"id": -1,
"method": "reflector_auth",
"params": {
"auth_info": {}
}
}- auth_info