Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
getting-started:updating [2017/08/01 10:06]
Elco Jacobs [Updating system firmware with DFU]
getting-started:updating [2018/05/02 22:32] (current)
Elco Jacobs [Updating the BrewPi Spark firmware with DFU]
Line 1: Line 1:
 ===== Updating the BrewPi server and BrewPi Spark ===== ===== Updating the BrewPi server and BrewPi Spark =====
 +To get fully up to date with the latest version of BrewPi, we need to update all 3 parts of BrewPi:
  
-==== Updating system firmware with DFU ==== +  - The BrewPi python script (brewpi-script) 
-The firmware on the BrewPi Spark with a Photon or P1 consists of 2 layers:+  - The BrewPi web interterface (brewpi-www) 
 +  - The BrewPi Spark firmware
  
-  * The BrewPi application +There are 2 ways to update the script and web interface: re-creating your docker container or updating an existing container.
-  * The Particle system framework+
  
-If you want to update to a version of BrewPi ​that requires a new system frameworkyou need to update over USB in DFU mode+==== Re-creating the docker container ==== 
-This can be done with our flashDfu.py python script.+If you installed ​BrewPi ​with dockerthe easiest way to do this is to just re-create the Docker container
 +Because your data and settings are stored outside of the container, you will not loose them.
  
-If you have installed BrewPi using docker, you probably did not start the container with USB forwarding. +If you made changes in your container ​outside of the datasettings ​and log directories,​ you will loose those.
-That's okay, we don't need to use your existing ​container ​to update ​the firmwarewe can just create another one for the update ​and destroy it afterwards.+
  
-For a raspberry pi, ssh into your docker ​host (use putty if you are on windows):+<​tabs>​ 
 + 
 +  * [[#​tab-recreate-image-pi|Raspberry Pi]] 
 +  * [[#​tab-recreate-image-other|Other systems]] 
 + 
 +<pane id="​tab-recreate-image-pi">​ 
 + 
 +**Ssh into the raspberry pi** 
 + 
 +First log into the shell of the docker ​machine using ssh (use putty if you are connecting from a Windows PC):
 <​code>​ <​code>​
 ssh pirate@192.168.1.100 ssh pirate@192.168.1.100
 </​code>​ </​code>​
 +The default password for HypriotOS is `hypriot`.
  
 +**Make sure you have the latest docker image**
 +
 +Run the code below to get the latest BrewPi image from DockerHub.
 +
 +<​code>​
 +docker pull brewpi/​brewpi-raspbian
 +</​code>​
 +
 +**Re-create the brewpi container**
 +
 +To create a new fresh container, take the following steps:
 +  - Show all running containers:<​code>​
 +  docker ps
 +  </​code>​ \\ You can refer to a container by name or container ID. \\ {{:​getting-started:​docker-ps.png|}}
 +  - Remove your existing container: <​code>​
 +  docker stop brewpi; docker rm brewpi
 +  </​code>​
 +  - Make sure you have the latest image: <​code>​
 +  docker pull brewpi/​brewpi-raspbian
 +  </​code>​
 +  - Create a new fresh container: <​code>​
 +  docker run -d --name brewpi -p 80:80 -v ~/​brewpi-data:/​data -v /​etc/​timezone:/​etc/​timezone -v /​etc/​localtime:/​etc/​localtime --restart always brewpi/​brewpi-raspbian
 +  </​code>​
 +</​pane>​
 +
 +
 +<pane id="​tab-recreate-image-other">​
 +
 +**Start a console to run docker commands**
 +
 +On Linux, just open a shell.
 +On Windows or Mac, you will find it in your start menu under the name //Docker Quickstart Terminal//.
 +
 +**Make sure you have the latest docker image**
 +
 +Run the code below to get the latest BrewPi image from DockerHub.
 +
 +<​code>​
 +docker pull brewpi/​brewpi-ubuntu
 +</​code>​
 +
 +**Re-create the brewpi container**
 +
 +To create a new fresh container, take the following steps:
 +  - Show all running containers:<​code>​
 +  docker ps
 +  </​code>​ \\ You can refer to a container by name or container ID. \\ {{:​getting-started:​docker-ps.png|}}
 +  - Remove your existing container: <​code>​
 +  docker stop brewpi; docker rm brewpi
 +  </​code>​
 +  - Make sure you have the latest image: <​code>​
 +  docker pull brewpi/​brewpi-ubuntu
 +  </​code>​
 +  - Create a new fresh container: <​code>​
 +  docker run -d --name brewpi -p 80:80 -v ~/​brewpi-data:/​data -v /​etc/​timezone:/​etc/​timezone -v /​etc/​localtime:/​etc/​localtime --restart always brewpi/​brewpi-ubuntu
 +  </​code>​
 +</​pane>​
 +
 +<pane id="​tab-recreate-image-linux">​
 Make sure you have the latest docker image: Make sure you have the latest docker image:
 +<​code>​
 +docker pull brewpi/​brewpi-ubuntu
 +</​code>​
 +
 +To create a new fresh container, take the following steps:
 +  - Show all running containers:<​code>​
 +  docker ps
 +  </​code>​ \\ You can refer to a container by name or container ID.
 +  - Remove your existing container: <​code>​
 +  docker stop brewpi; docker rm brewpi
 +  </​code>​
 +  - Make sure you have the latest image: <​code>​
 +  docker pull brewpi/​brewpi-ubuntu
 +  </​code>​
 +  - Create a new fresh container: <​code>​
 +  docker run -d --name brewpi -p 80:80 -v ~/​brewpi-data:/​data -v /​etc/​timezone:/​etc/​timezone -v /​etc/​localtime:/​etc/​localtime --restart always brewpi/​brewpi-ubuntu
 +  </​code>​
 +</​pane>​
 +
 +</​tabs>​
 +
 +==== Updating an existing BrewPi server/​container ====
 +Most BrewPi installs will also have our ''​brewpi-tools''​ repository installed in ''​~/​brewpi-tools''​. Our latest docker container includes it too.
 +
 +Log in on the console of your BrewPi server. If you are running docker with portainer, you can do this by going to <ip address>:​9000,​ then go to your BrewPi container and click '​console'​.
 +
 +Then simply run our update-script:​
 +
 +<​code>​
 +cd ~/​brewpi-tools
 +python updater.py
 +</​code>​
 +
 +==== Updating the BrewPi Spark firmware with DFU ====
 +
 +DFU is a specialized USB protocol. To use DFU mode, the Spark should be connected via USB to your computer or Raspberry Pi.
 +When updating over DFU, you will first put the Spark in DFU mode by rebooting into the bootloader.
 +
 +This can be done by: 
 + 
 +  - holding the setup button while it boots, until the LED flashes yellow. You can reboot by pressing the reset button (while holding the setup button) or reconnecting power (while holding the setup button), or
 +  - triggering it in software (with our script). Our script will do that for you if you use the option ''​--autodfu'',​ which we will get to later.
 +
 +The process to update is for:
 +
 +  * Docker or no docker
 +  * Whether you run docker on a Raspberry Pi, Linux, Windows or Mac. The process is described separately in each tab.
 +
 +---------------
 +
 +=== Without docker ===
 +If you installed BrewPi without docker, you will only need to run this command on your system:
 +<​code>​
 +python utils/​flashDfu.py --noreset --autodfu
 +</​code>​
 +
 +---------------
 +
 +=== With docker ===
 +To update over DFU, we will use a new temporary privileged container that is destroyed after use.
 +
 +<​tabs>​
 +
 +  * [[#​tab-pi|Raspberry Pi]]
 +  * [[#​tab-windows|Windows]]
 +  * [[#​tab-linux|Linux]]
 +  * [[#​tab-mac|Mac]]
 +
 +<pane id="​tab-pi">​
 +The following commands are performed from the console on pi. See above to log into the pi using SSH.
 +
 +We can start a docker container for single use that is destroyed afterwards (''​--rm''​) and run the flashDfu.py script directly inside the container.
 +These 3 commands pull the latest docker image, trigger DFU mode and perform the update.
 <​code>​ <​code>​
 docker pull brewpi/​brewpi-raspbian docker pull brewpi/​brewpi-raspbian
 +docker run -it --name brewpi-dfu --privileged -v ~/​brewpi-data:/​data --rm brewpi/​brewpi-raspbian python utils/​flashDfu.py --trigger
 +docker run -it --name brewpi-dfu --privileged -v ~/​brewpi-data:/​data --rm brewpi/​brewpi-raspbian python utils/​flashDfu.py --noreset
 </​code>​ </​code>​
  
-Connect the Spark with USB and put it in DFU mode. This can be done by holding the setup button and doing a reset. Keep holding the button until the LED flashes yellow.+</​pane>​
  
-We can start a docker ​container for single use that is destroyed afterwards (''​--rm''​and run the flashDfu.py script directly:+<pane id="​tab-windows">​ 
 +**Install drivers** 
 + 
 +  * Make sure all necessary drivers are installed by installing [[https://​binaries.particle.io/​cli/​installer/​windows/​ParticleCLISetup.exe|Partile CLI]] 
 + 
 +**Give docker-machine access to USB devices** 
 + 
 +Docker runs in as Virtualbox virtual machine if you installed with Docker toolbox. By default, this machine does not have access to USB devices. To give it access, take the following steps: 
 + 
 +  - Stop the running ​docker ​machine by typing this in your docker console:\\ <​code>​docker-machine stop</​code>​ 
 +  - Start ''​Oracle VM Virtualbox''​ from your Start Menu 
 +  ​Find the virtual machine called ''​default'',​ right click it and open Settings. 
 +  ​Go to the USB tab and enable the USB controller 
 +  - Click ''​Add device filter''​ and chose the ''​Particle P1/​Photon''​ device \\ {{:​getting-started:​docker-windows-add-usb-devices.png?​nolink&​800|}} 
 +  - Put the BrewPi Spark in DFU mode 
 +  - Click ''​Add device filter''​ and chose the ''​Particle P1/Photon DFU mode''​ device 
 +  - Save your settings by clicking OK 
 +  - Go back to the docker console and restart the docker machine:​\\<​code>​docker-machine start</​code>​ 
 + 
 +**Check that DFU is working inside the brewpi-ubuntu container now** 
 +Make sure you have the latest docker image:
 <​code>​ <​code>​
-docker ​run -it --name ​brewpi-dfu --privileged -v ~/brewpi-data:/data --rm brewpi/​brewpi-raspbian python utils/​flashDfu.py --tag=0.5.3 --noreset+docker ​pull brewpi/​brewpi-ubuntu
 </​code>​ </​code>​
  
-Resetting to factory defaults doesn'​t work yet, which is why we specify ​''​--noreset''​. ​This is because ​the serial port is not available in the container. ​If reset is required, you can use the '​Reset ​to factory defaults'​ button in advanced settings.+Make sure your BrewPi Spark is in DFU mode (blinking yellow) and run: 
 +<​code>​ 
 +docker run -it --name brewpi-dfu --privileged -v ~/​brewpi-data:/​data --rm brewpi/​brewpi-ubuntu dfu-util -l 
 +</​code>​ 
 +The output should look like this: 
 + 
 +{{:​getting-started:​docker-windows-dfu-util-test.png?​nolink&​800|}} 
 + 
 +Finally, ​we can start a docker container for single use that is destroyed afterwards (''​--rm''​) and run the flashDfu.py script directly inside ​the container. 
 +<​code>​ 
 +docker run -it --name brewpi-dfu --privileged -v ~/​brewpi-data:/​data --rm brewpi/​brewpi-ubuntu python utils/​flashDfu.py --trigger 
 +docker run -it --name brewpi-dfu --privileged -v ~/​brewpi-data:/​data --rm brewpi/​brewpi-ubuntu python utils/​flashDfu.py --noreset 
 +</​code>​ 
 + 
 +</​pane>​ 
 + 
 +<pane id="​tab-linux">​ 
 +Make sure you have the latest docker image: 
 +<​code>​ 
 +docker pull brewpi/​brewpi-ubuntu 
 +</​code>​ 
 + 
 +We can start a docker container for single use that is destroyed afterwards (''​--rm''​) and run the flashDfu.py script directly inside ​the container
 +<​code>​ 
 +docker run -it --name brewpi-dfu --privileged -v ~/​brewpi-data:/​data --rm brewpi/​brewpi-ubuntu python utils/​flashDfu.py --trigger 
 +docker run -it --name brewpi-dfu --privileged -v ~/​brewpi-data:/​data --rm brewpi/​brewpi-ubuntu python utils/​flashDfu.py --noreset 
 +</​code>​ 
 + 
 +</​pane>​ 
 + 
 +<pane id="​tab-mac">​ 
 +I do not have Mac to test the procedure, so unfortunately I cannot write this piece of documentation myself. 
 +Because Docker ​is installed on OSX with docker-machinejust like in Windows, most of the instructions for Windows will probably apply. 
 + 
 +If you have installed BrewPi on OSX with Docker, please help us update these instructions. 
 + 
 +</​pane>​ 
 +   
 +</​tabs>​ 
 + 
 +--------------- 
 + 
 +If you are upgrading from an old version, it is possible that your BrewPi Spark is displaying a white screen and the LED is blinking green rapidly. You can get past this by [[:how-to-setup-wifi-on-the-brewpi-spark|setting up WiFi]].