{"id":19208098,"url":"https://github.com/artcc/octoprint-siri-rpi","last_synced_at":"2025-05-12T18:50:01.583Z","repository":{"id":43823965,"uuid":"249002277","full_name":"ArtCC/OctoPrint-Siri-RPi","owner":"ArtCC","description":"Use OctoPrint with Siri and shortcuts with a Raspberry Pi and Node.js","archived":false,"fork":false,"pushed_at":"2022-12-12T06:31:18.000Z","size":2405,"stargazers_count":5,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-20T15:44:30.204Z","etag":null,"topics":["api","api-rest","homepod","ios","ipad","iphone","nodejs","octoprint","printer","printer3d","raspberry-pi","shortcut","shortcuts","siri","siri-shortcuts","voice"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ArtCC.png","metadata":{"files":{"readme":"README.MD","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-03-21T15:17:30.000Z","updated_at":"2023-08-08T16:43:59.000Z","dependencies_parsed_at":"2023-01-27T15:01:17.068Z","dependency_job_id":null,"html_url":"https://github.com/ArtCC/OctoPrint-Siri-RPi","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArtCC%2FOctoPrint-Siri-RPi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArtCC%2FOctoPrint-Siri-RPi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArtCC%2FOctoPrint-Siri-RPi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArtCC%2FOctoPrint-Siri-RPi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ArtCC","download_url":"https://codeload.github.com/ArtCC/OctoPrint-Siri-RPi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253803981,"owners_count":21967012,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","api-rest","homepod","ios","ipad","iphone","nodejs","octoprint","printer","printer3d","raspberry-pi","shortcut","shortcuts","siri","siri-shortcuts","voice"],"created_at":"2024-11-09T13:24:11.809Z","updated_at":"2025-05-12T18:50:00.786Z","avatar_url":"https://github.com/ArtCC.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Use OctoPrint with Siri and shortcuts with a Raspberry Pi and Node.js\n\n![OctoPrint logo](https://github.com/ArtCC/Octoprint-Siri-RPi/blob/main/src_github/OctoPrint.png)\n![Plus](https://github.com/ArtCC/Octoprint-Siri-RPi/blob/main/src_github/Plus.png)\n![Siri logo](https://github.com/ArtCC/Octoprint-Siri-RPi/blob/main/src_github/Siri.png)\n\n(I'm sorry but I don't have a 3D printer anymore...)\n\nWith this project you will be able to control your 3D printer if you use OctoPrint as a print server with Siri from your iOS, iPadOS, macOS or HomePod using the Apple Shortcuts.\n\nYou will need a Raspberry Pi with OctoPrint and Node.js installed.\n\nAfter following my tutorial you will be able to control by voice and Siri your 3D printer.\n\nI'm an iOS developer from Madrid, Spain.\n\nI hope you like the project, I'm open to all kind of help and modifications.\n\nThank you very much!\n\nArturo :)\n\n## Configuration\n\n- Install and configure OctoPrint in your Raspberry Pi for your 3D printer:\n\n\t- [OctoPrint official web](https://octoprint.org)\n\n- With OctoPrint installed and connected to your network, open your terminal on your MacBook (if you use Windows use [Putty](https://putty.org)) and type (User for default: \u003cb\u003epi\u003c/b\u003e and password for default: \u003cb\u003eraspberry\u003c/b\u003e):\n\n```\nssh pi@OCTOPRINT_IP\n```\n\n- Now, you need install Node.js in your Raspberry Pi with OctoPrint:\n\n```\ncurl -sL https://deb.nodesource.com/setup_13.x | sudo -E bash -\n```\n\n```\nsudo apt install -y nodejs\n```\n\n- Now, you need to install nodemon to leave the REST API up:\n\n```\nsudo npm install -g nodemon\n```\n\n- Download and unzip in your MacBook or another pc this file:\n\n[Source](https://github.com/ArtCC/OctoPrint-Siri-RPi/blob/main/source/OctoPrint-Siri-RPi.zip)\n\n- Open config.js file and add your OctoPrint API KEY in this constant:\n\n```\nconst API_KEY = 'YOUR_OCTOPRINT_API_KEY';\n```\n\n- Use FileZilla or another application to transfer this folder to your Raspberry Pi with OctoPrint. If you use FileZilla use this setting to connect to your OctoPrint server:\n\n```\nsftp://OCTOPRINT_IP\nuser: pi\npassword: raspberry\n```\n\n- Now, go back to your OctoPrint terminal connected by SSH and run the following script, your new intermediate API for using Apple Shortcuts will be up and running:\n\n```\n./start.sh\n```\n\n- Close the terminal with OctoPrint without canceling nodemon.\n\n## Siri shortcuts\n\nAdd these shortcuts by opening the link on your iOS or iPadOS device where you have installed the Shortcuts application. They are in Spanish but you can modify the texts when you add them to your application.\n\n[Download Shortcuts examples with captures](https://github.com/ArtCC/OctoPrint-Siri-RPi/blob/main/src_github/Shortcuts_captures.zip)\n\n## Notes\n\nIt is a first version of the project, I will be improving both the installation and the operation in general.\nWhy have I decided not to use the OctoPrint API directly from Shortcuts? To have the possibility of empowering my likes to the service and to not complicate the configuration of each Shortcut.\n\n## LICENSE\n\nThis project is free and use \u003cb\u003eCC BY-NC-SA\u003c/b\u003e.\n\nThis license lets others remix, tweak, and build upon your work without for commercial purposes, as long as they credit you and license their new creations under the identical terms.\n\n## THANK YOU!\n\nI hope you like it!\n\n##### ArtCC 2020++\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fartcc%2Foctoprint-siri-rpi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fartcc%2Foctoprint-siri-rpi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fartcc%2Foctoprint-siri-rpi/lists"}