jellespijker / home-assistant-ultimaker

Home-Assistant component for Ultimaker printers (UM3, S3, S5)

Home Assistant Ultimaker printers

Adds support for the following ultimaker printer sensors:

• Printer status
• Print job state
• Print job progress
• Hotend id (AA 0.4, BB 0.4, ...)
• Hotend temperature
• Hotend target temperature
• Bed type (glass, ...)
• Bed temperature
• Bed target temperature

Install

Using HACS:

Just search for ultimaker in the HACS integration bar

From source:

Copy the ultimaker directory in your own custom_components folder

Usage

configuration.yaml

sensor:
  - platform: ultimaker
    name: name
    host: ip_adress
    scan_interval: 10  # optional, default 10
    decimal: 2  # optional, default 2 rounds the sensor values
    sensors:
      - status  # optional
      - state  # optional
      - progress  # optional
      - bed_type  # optional
      - bed_temperature  # optional
      - bed_temperature_target  # optional
      - hotend_1_id  # optional
      - hotend_1_temperature  # optional
      - hotend_1_temperature_target  # optional
      - hotend_2_id  # optional
      - hotend_2_temperature  # optional
      - hotend_2_temperature_target  # optional

add a camera to the configuration.yaml

camera:
  - platform: generic
    still_image_url: http://ip_adress:8080/?action=snapshot
    framerate: 4

add a lovelace card to the UI

type: vertical-stack
cards:
  - type: entity
    entity: sensor.printername_print_job_state
  - type: conditional
    conditions:
      - entity: sensor.printername_printer_status
        state: printing
    card:
      type: picture-entity
      entity: sensor.printername_print_job_progress
      camera_image: camera.generic_camera
      camera_view: live
  - type: gauge
    entity: sensor.printername_print_job_progress
    min: 0
    max: 100
    severity:
      green: 66
      yellow: 33
      red: 0

home-assistant-ultimaker's Issues

Configuring Generic IP Camera using YAML is being removed.

Hi, it looks like the generic platform is being deprecated in an upcoming version.

[Feature Request] Add config flow with automatic printer discovery

Add config flow with automatic printer discovery

TEMP_CELSIUS was used from ultimaker

Hey,

I get the following error. It says I should report it.

2024-02-07 13:40:14.542 WARNING (MainThread) [homeassistant.const] TEMP_CELSIUS was used from ultimaker, this is a deprecated constant which will be removed in HA Core 2025.1. Use UnitOfTemperature.CELSIUS instead, please create a bug report at https://github.com/jellespijker/home-assistant-ultimaker/issues

[Feature Request] Use "devices"

Would it be possible to present the printers as devices in hass? https://developers.home-assistant.io/docs/creating_platform_index

[Feature Request] HACS integration

Enable HACS integration for easy installation https://hacs.xyz/

Two PRs:

• hacs/default#772
• home-assistant/brands#2150

[Enhancement] Float values vs string values

Some sensors such us print core, printer status or printed type should be a string, not a float, not possible to manage the history with float values for strings, and therefore automations harder to program (when going from printing to paused)

(Float values -> numbers
String values -> text)

Invalid config for [sensor.ultimaker]: value must be one of ... Got 'print_job_name'

Copied the example config for sensors and got:

2021-02-04 08:30:29 ERROR (MainThread) [homeassistant.config] Invalid config for [sensor.ultimaker]: value must be one of ['bed_temperature', 'bed_temperature_target', 'hotend_1_temperature', 'hotend_1_temperature_tar
get', 'hotend_2_temperature', 'hotend_2_temperature_target', 'progress', 'state', 'status'] @ data['sensors'][3]. Got 'print_job_name'
value must be one of ['bed_temperature', 'bed_temperature_target', 'hotend_1_temperature', 'hotend_1_temperature_target', 'hotend_2_temperature', 'hotend_2_temperature_target', 'progress', 'state', 'status'] @ data['s
ensors'][4]. Got 'print_job_finished'. (See /config/more.sensors/misc.sensors.yaml, line 72). Please check the docs at https://github.com/jellespijker/home-assistant-ultimaker
2021-02-04 08:30:29 ERROR (MainThread) [homeassistant.config] Invalid config for [sensor.ultimaker]: value must be one of ['bed_temperature', 'bed_temperature_target', 'hotend_1_temperature', 'hotend_1_temperature_tar
get', 'hotend_2_temperature', 'hotend_2_temperature_target', 'progress', 'state', 'status'] @ data['sensors'][3]. Got 'print_job_name'
value must be one of ['bed_temperature', 'bed_temperature_target', 'hotend_1_temperature', 'hotend_1_temperature_target', 'hotend_2_temperature', 'hotend_2_temperature_target', 'progress', 'state', 'status'] @ data['s
ensors'][4]. Got 'print_job_finished'. (See /config/more.sensors/misc.sensors.yaml, line 89). Please check the docs at https://github.com/jellespijker/home-assistant-ultimaker

[Feature request] Print job end time(date)

Hello

Thank you for a very nice add-in, that I Enjoy very much.
What I miss is the timestamp for completion of the printjob. It is there in the Android App, and in Cura (monitor/web view), so I would guess its somewhere to finde via the API you are accessing too ?

Michael

Add support to 2+ Connect

Hi, it would be awesome if you could add support for the Ultimaker 2+ Connect.

I have one, so happy to test anything.

ETF Sensor would be nice

An estimated time of finishing sensor would be nice, based on the current time and the print-time remaining. It can be done with a template sensor, but it's a bit of a hassle.

make Ultimaker platform compatible with HA OS 5.12

I’m trying to set up the integration with an UltimakerS5

However no devices or entities get created..

Not sure where I could be going wrong:

sensor:

• platform: ultimaker
  name: UltimakerS5
  host: 172.24.1.109
  scan_interval: 10 # optional, default 10
  decimal: 2 # optional, default 2 rounds the sensor values
  sensors:
  • status # optional
  • state # optional
  • progress # optional
  • bed_type # optional
  • bed_temperature # optional
  • bed_temperature_target # optional
  • hotend_1_id # optional
  • hotend_1_temperature # optional
  • hotend_1_temperature_target # optional
  • hotend_2_id # optional
  • hotend_2_temperature # optional
  • hotend_2_temperature_target # optional

addon gives a lot of warnings when UM3 is off: BUG

addon gives a lot of warnings when UM3 is off.
The addon works nice, but if the Ultimaker is powered off and HA is restarted it creates a lot of warnings (and slows down the HomeAssistant boot also).

Logfile give a lot of these entries;
2022-06-16 21:53:10 WARNING (MainThread) [custom_components.ultimaker.sensor] Printer 192.168.1.34 is offline
2022-06-16 21:53:20 WARNING (MainThread) [custom_components.ultimaker.sensor] Printer 192.168.1.34 is offline
2022-06-16 21:53:40 WARNING (MainThread) [custom_components.ultimaker.sensor] Printer 192.168.1.34 is offline
2022-06-16 21:53:50 WARNING (MainThread) [custom_components.ultimaker.sensor] Printer 192.168.1.34 is offline

For now, I have removed the addon...
Latest addon version v0.1.5 (16-6-2022 new installed), gives still a lot of warnings,

when printer is disconnected and HA starts it will slowdown the startup of HA

Gracefully handle the case of initialization when the printer isn't connected.

Use non-ultimaker printer

Hi, I am not sure how ultimaker printer are connected so I give myself a chance asking you if you think it would be possible to add non-ultimaker printer to your integration ? I am using a wanhao d12 230 with cura. The printer is wifi connected and I am able to send print via wifi such as following on cura temperature states and printing progress. Is it based on cura software communication or is it completely separate ? Thanks.

UM3 with USB

I have UM3 with only USB port--any chance to get that working? This looks like a great module and I would love to be able to use it.
Thank you!

setup HACS info.md

Such that the user can see the changelog directly from the HACS UI

[Feature Request] Add Ultimaker Digital Factory support

Ultimaker digital factory is the API for cloud connected printers.

• https://docs.api.ultimaker.com/guides/getting-started/
• https://docs.api.ultimaker.com/cura/spec/

Share json example for full dashboard shown in screenshot

Min or request which may help others - Please update documentation to reflect the full json of the screenshot/example dashboard