diff --git a/README.md b/README.md index 0d343d75..23198849 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,14 @@ Mainsail is a lightweight & responsive web interface for the [Klipper](https://github.com/KevinOConnor/klipper) 3D printer firmware. It communicates with the [Moonraker (Klipper-API)](https://github.com/arksine/moonraker) from [Arksine](https://github.com/arksine). -![screenshot-dashboard](docs/images/screenshot-dashboard.png) +![screenshot-dashboard](docs/assets/img/screenshot.png) To begin using Mainsail start by [installing](https://github.com/meteyou/mainsail/wiki/Installation) it or read the [Wiki Pages](https://github.com/meteyou/mainsail/wiki) for more informations. ## Credit, sources and inspiration * [Kevin O'Connor](https://github.com/KevinOConnor) for the awesome 3D printer firmware [Klipper](https://github.com/KevinOConnor/klipper) * [Eric Callahan (arksine)](https://github.com/Arksine) for [Moonraker (Klipper API)](https://github.com/Arksine/moonraker). Without Moonraker, Mainsail would not be possible. -* [lixxbox](https://github.com/lixxbox) for the Mainsail logo +* [lixxbox](https://github.com/lixxbox) for the Mainsail logo & Docs * [Vue.js](https://vuejs.org/): The Progressive JavaScript Framework * [Vuetify](https://vuetifyjs.com/): Material Design Component Framework for Vue.js diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..67260c6e --- /dev/null +++ b/docs/README.md @@ -0,0 +1 @@ +Welcome to the Mainsail documentation. The [index](http://meteyou.github.io/mainsail) of the docs is here. \ No newline at end of file diff --git a/docs/assets/img/screenshot.png b/docs/assets/img/screenshot.png index dca8c942..5028214b 100644 Binary files a/docs/assets/img/screenshot.png and b/docs/assets/img/screenshot.png differ diff --git a/docs/necessary-cfg.md b/docs/necessary-cfg.md index ce7084de..acd7793c 100644 --- a/docs/necessary-cfg.md +++ b/docs/necessary-cfg.md @@ -1,7 +1,7 @@ --- layout: default title: Necessary Configuration -nav_order: 3 +nav_order: 4 has_children: false permalink: /necessary-configuration --- diff --git a/docs/setup-guide/mainsail.md b/docs/setup-guide/mainsail.md index ca62a215..ca58cbeb 100644 --- a/docs/setup-guide/mainsail.md +++ b/docs/setup-guide/mainsail.md @@ -173,7 +173,7 @@ Now you can download the current mainsail static data ``` cd ~/mainsail -wget -q -O mainsail.zip https://github.com/meteyou/mainsail/releases/download/v0.2.6/mainsail-beta-0.2.6.zip && unzip mainsail.zip && rm mainsail.zip +wget -q -O mainsail.zip https://github.com/meteyou/mainsail/releases/download/latest/mainsail.zip && unzip mainsail.zip && rm mainsail.zip ``` Now it should be possible to open the interface: `http:///`. diff --git a/docs/update-guide/index.md b/docs/update-guide/index.md new file mode 100644 index 00000000..66561f7e --- /dev/null +++ b/docs/update-guide/index.md @@ -0,0 +1,59 @@ +--- +layout: default +title: Update Guide +nav_order: 3 +has_children: true +permalink: /update/ +--- + +## Update Klipper +``` +cd ~/klipper +git fetch +git checkout origin/master +``` + +Please check the location of the `~/klipper_config/printer.cfg` and the UDS (`-a /tmp/klippy_uds`) in the `/etc/default/klipper` file. This +should look like: +``` +KLIPPY_ARGS="/home/pi/klipper/klippy/klippy.py /home/pi/klipper_config/printer.cfg -l /tmp/klippy.log -a /tmp/klippy_uds" +``` +If you have to change the location of `printer.cfg` in `/etc/default/klipper` +please create the directory `~/klipper_config` and move your config files in this directory. + +Restart Klipper (`sudo service klipper restart`) and check the `klippy.log`, if Klipper starts +correctly and then continue the guide. + +## Update Moonraker (API) +``` +cd ~/moonraker +git fetch +git checkout origin/master +``` + +Restart Moonraker (`sudo service moonraker restart`) and open the url `http://:7125/printer/info` in your browser. + +If you see a content like this +``` +{"result": {"hostname": "voron250", "error_detected": false, "version": "v0.8.0-643-g528f9f25", "is_ready": true, "message": "Printer is ready", "cpu": "4 core ARMv7 Processor rev 4 (v7l)"}} +``` + +### Update moonraker dependence +This is only nessasary, if your moonraker version is older than 31. october 2020. +``` +~/moonraker/scripts/install-moonraker.sh -r +``` + +## Update Mainsail (webinterface) +``` +cd ~/mainsail +rm -R ./* +wget -q -O mainsail.zip https://github.com/meteyou/mainsail/releases/download/v0.2.6/mainsail-beta-0.2.6.zip && unzip mainsail.zip && rm mainsail.zip +``` +### Move gui.json from gcodes to klipper_config +This is only necessary if you update from 0.2.2 to 0.2.3 or higher. If you use MainsailOS, the virtual_sdcard directory is `gcode_files` instead of `sdcard`. +``` +mv ~/sdcard/gui.json ~/klipper_config/ +``` + +Now it should be possible to open the interface: `http:///`. \ No newline at end of file diff --git a/docs/update-guide/klipper.md b/docs/update-guide/klipper.md new file mode 100644 index 00000000..1ce3273e --- /dev/null +++ b/docs/update-guide/klipper.md @@ -0,0 +1,24 @@ +--- +layout: default +title: Klipper +parent: Update Guide +nav_order: 2 +permalink: /update/klipper +--- + +## Klipper +### Update from Repository +```bash +cd ~/klipper +git fetch +git checkout origin/master +``` + +Restart Klipper (`sudo service klipper restart`) and check the `klippy.log`, if Klipper starts +correctly and then continue the guide. + +### Klipper config changes +If you have issues after update your Klipper instance, you can check config changes [here](https://github.com/KevinOConnor/klipper/blob/master/docs/Config_Changes.md). + +--- +[< table of contents](index.md){: .btn } [next step >](moonraker.md){: .btn} diff --git a/docs/update-guide/mainsail.md b/docs/update-guide/mainsail.md new file mode 100644 index 00000000..805cae3d --- /dev/null +++ b/docs/update-guide/mainsail.md @@ -0,0 +1,25 @@ +--- +layout: default +title: Mainsail +parent: Update Guide +nav_order: 4 +permalink: /update/mainsail +--- + +## Mainsail +```bash +cd ~/mainsail +rm -R ./* +wget -q -O mainsail.zip https://github.com/meteyou/mainsail/releases/download/latest/mainsail.zip && unzip mainsail.zip && rm mainsail.zip +``` + +### Move gui.json from gcodes to klipper_config +This is only necessary if you update from 0.2.2 to 0.2.3 or higher. If you use MainsailOS, the virtual_sdcard directory is `gcode_files` instead of `sdcard`. +``` +mv ~/sdcard/gui.json ~/klipper_config/ +``` + +Now it should be possible to open the interface: `http:///`. + +--- +[< previous step](moonraker.md){: .btn } diff --git a/docs/update-guide/moonraker.md b/docs/update-guide/moonraker.md new file mode 100644 index 00000000..7a32cc75 --- /dev/null +++ b/docs/update-guide/moonraker.md @@ -0,0 +1,33 @@ +--- +layout: default +title: Moonraker +parent: Update Guide +nav_order: 3 +permalink: /update/moonraker +--- + +## Moonraker +```bash +cd ~/moonraker +git fetch +git checkout origin/master +``` + +Restart Moonraker (`sudo service moonraker restart`) and open the url `http://:7125/printer/info` in your browser. + +If you see a content like this +``` +{"result": {"hostname": "voron250", "error_detected": false, "version": "v0.8.0-643-g528f9f25", "is_ready": true, "message": "Printer is ready", "cpu": "4 core ARMv7 Processor rev 4 (v7l)"}} +``` + +### Update Moonraker dependence +This is only nessasary, if your Moonraker version is older than 31. october 2020. +```bash +~/moonraker/scripts/install-moonraker.sh -r +``` + +### Moonraker config changes +If you have issues after update your Moonraker instance, you can check config changes [here](https://github.com/Arksine/moonraker/blob/master/docs/user_changes.md). + +--- +[< previous step](klipper.md){: .btn } [next step >](mainsail.md){: .btn } diff --git a/src/components/panels/ToolsPanel.vue b/src/components/panels/ToolsPanel.vue index 340b7ea6..4a6d3c88 100644 --- a/src/components/panels/ToolsPanel.vue +++ b/src/components/panels/ToolsPanel.vue @@ -22,7 +22,7 @@ Name - Status + Status Current Target @@ -33,7 +33,7 @@ mdi-{{ heater.icon }} {{ heater.name }} - {{ heater.target > 0 ? "active" : "off" }} + {{ heater.target > 0 ? "active" : "off" }} {{ heater.temperature ? heater.temperature.toFixed(1) : 0 }}°C @@ -47,7 +47,7 @@ mdi-fan {{ fan.name }} - {{ fan.target > 0 && fan.speed > 0 ? (fan.speed * 100).toFixed(0)+"%" : (fan.target > 0 ? "standby" : "off") }} + {{ fan.target > 0 && fan.speed > 0 ? (fan.speed * 100).toFixed(0)+"%" : (fan.target > 0 ? "standby" : "off") }} {{ fan.temperature ? fan.temperature.toFixed(1) : 0}}°C @@ -61,7 +61,7 @@ {{ sensor.icon }} {{ sensor.name }} -   +   {{ sensor.temperature ? sensor.temperature.toFixed(1) : 0 }}°C diff --git a/vue.config.js b/vue.config.js index 31c35f88..e8f8f31b 100644 --- a/vue.config.js +++ b/vue.config.js @@ -1,5 +1,4 @@ const webpack = require('webpack') -const SWPrecacheWebpackPlugin = require('sw-precache-webpack-plugin') const fs = require('fs') const packageJson = fs.readFileSync('./package.json') const version = JSON.parse(packageJson).version || 0 @@ -15,18 +14,10 @@ module.exports = { PACKAGE_VERSION: '"' + version + '"' } }), - new SWPrecacheWebpackPlugin({ - cacheId: 'mailsail', - filename: 'service-worker-cache.js', - staticFileGlobs: ['dist/**/*.{js,css}', '/'], - minify: true, - stripPrefix: 'dist/', - dontCacheBustUrlsMatching: /\.\w{6}\./ - }), ] }, pwa: { - serviceWorker:true, + serviceWorker:false, iconPaths: { favicon16: 'img/icons/favicon-16x16.png', favicon32: 'img/icons/favicon-32x32.png',