Repository files navigation

1. Download the app
2. General
3. Push-Notifications
4. App Screenshots
5. Translations
6. Environment Setup for Contribution
7. Changelog
8. License

🏷️ Mobileraker works as a simple UI for Klipper on the phone. Connect it to an existing moonraker installation andcontrol the printer.

🧰 With Mobileraker, the user has access to critical machine commands:

• Pause, Resume, Stop a print job
• Monitor the print progress
• Control all axis of the machine
• Control the heaters
• Get the current temperature readings
• Control fans
• Control pins like LEDs
• Send GCode Macros
• Emergency Stop the machine

🛠️ Additionally, Mobileraker enables the user to monitor the machine via an integrated webcam viewer with support formultiple cams, interact with the machine through the GCode console and browse the available GCode files to start a newprint job.Mobileraker also offers comfort features like remote push notifications about the progress of a print job, temperaturepresets.

✨ One more thing ...Mobileraker can manage multiple machines!

✍🏻 Some final words from the project owner:Hi,My name is Patrick Schmidt, and I am the developer of Mobileraker. Mobileraker started as a small side project with theintention to be able to control My 3D printer via My phone. After posting some screenshots of the app to the 3D printingcommunity, the public interest in Mobileraker grew, and I published it to the app stores.As I am only able to work on Mobileraker in my free time, I am always thankful for support and feedback. Either vialovely messages of people enjoying Mobileraker, good reviews in the store or through donations. I hope you enjoyMobileraker and happy printing 🙏!

Note
Android's progress notification (Shown in the Impression Images) is not supported anymore, due to a change in a 3rdpartylibrary. As soon as this library offers support for this kindofnotification again, I will revisit the implementation (Feel free to contribute).

Mobileraker allows users to enable push notifications, which are also delivered if your phone is not in the same networkas your klipperized 3D printer. To allow Mobileraker to send push notifications to your phone, please install andconfigure theMobileraker's Companion. You can learn more about itby visiting theMobileraker's Companion GitHub project to learnmore.

Mobileraker already supports multiple languages, but it relies on contributions to add new languages and keep existingtranslations up to date. If you want to add your own language or update an existing one, please feel free to open a PullRequest (PR). Thisguide provides details on the structure of translation keys and how to adda new language.

Note:
This section outlines the steps required for contributors who wish to enhance or contribute to the project, or forthose who want to build the app locally.

1. Flutter and FlutterFire Installation:

   • Ensure that you haveFlutterandFlutterFireinstalled on your machine.

2. Import Project into IDE:

   • Import the project into your preferred Integrated Development Environment (IDE).

3. Clone themobileraker_pro_pub Repository:

   • Clone themobileraker_pro repository into same location as themobileraker repository.
   • Folder structure should look like this:

     .├── mobileraker└── mobileraker_pro_pub

4. Configure Dependency inpubspec.yaml:

   • Inpubspec.yaml, verify that thepath option for themobileraker_pro dependency is used thatpoints to the clonedmobileraker_pro_pub repository.

     ...mobileraker_pro:path:../mobileraker_pro_pub

5. Generate Required Files:

   • Run the following commands in the terminal of the repos root folder:

     flutter pub getflutter packages pub run build_runner buildcd commonflutter pub getflutter packages pub run build_runner build

     This will generate necessary files in both the root folder and thecommon folder.

6. Firebase Configuration:

   • Run the command:

     flutterfire configure

     This step configures your Firebase project, targeting both Android and iOS platforms, and generatesafirebase_options.dart file.

7. Updatefirebase_options.dart:

   • Replace the contents of thefirebase_options.dart file in the clonedmobileraker_pro_pub repository with thecontents of thefirebase_options.dart file generated in the previous step.

8. Run the App:

   • Run the app on your preferred device or emulator. Happy coding!

The changelog can be found indocs/changelog.md.

The project is licensed under the Mobileraker License v2, an updated version of the Mobileraker License v1 crafted byPatrick Schmidt which itself was based on the MIT license.This license permits non-commercial use, redistribution, and modification of the software and documentation, providedthat copyright and permission notices are preserved. However, commercial usage is restricted unless explicit writtenconsent is obtained from Patrick Schmidt, who also maintains all intellectual property rights.

The project was initially licensed under the MIT License until the 11th of June 2023. Afterward, it transitioned to theMobileraker License v1 until the 19th of May 2024. Since then, the project is licensed under the Mobileraker License v2.

For more details, please refer to theLICENSE file.