Jump to: navigation, search

Release notes Umikaze 2.1.1

Revision as of 20:18, 5 September 2017 by Jon (talk | contribs)

Release notes

It's been a good 8 months in coming.

Below follows a list of features added to 2.1.1 since Kamikaze 2.1.0 came out:

  • BeagleBone Black Wireless support
  • Development branch of Redeem installed by default, to get the latest goodies.
  • TI C PRU compilation software packages (for new PRU firmwares in use on the development branch of redeem)
  • CPU governor fixed to "performance" by default, guaranteeing superior computational power when printing
  • Octoprint version number now the official release version, instead of git commit modifications.

Granted it sounds like a small feature change, given the amount of time it took to get it all done. However the trickiest of them was the wireless support. That alone took nearly 4 months of tinkering with the kernel in all sorts of ways to get it just right.

Now for the reason the release is made available before the integrated backup & restore of config files is built: The new version of Redeem requires the TI C PRU software packages (and a few python ones) not available in previous images of Kamikaze.

Before merging the develop branch into master for Redeem, we want to make sure our users have all the needed tools to be able to install it, thus, 2.1.1.

So how do you upgrade to 2.1.1 without losing your files? Choose your current version below to get to the right section as needed:

Important notice about redeem

If you've been running a recent develop checkout (i.e. less than 3 months old) you can skip this section and move on.

The redeem code consists of multiple components, that run in different ways. Two of them are PRU firmwares - independent real-time pieces of code similar in essence to what arduino sketches would do (pardon the layman's explanation if you know better). The PRU firmwares in master until Kamikaze 2.1.0 were originally written by Elias Bakken in PRU assembly language and served the Replicape community well. But they were, in fact, not perfect. For one thing, the speeds and accelerations were incorrect - generally lower values physically than what was defined in the configuration. Andrew Wiley, one of the fearless redeem developers, has fixed that, by re-writing the PRU firmwares in C.

This means that any speed or acceleration value you had previously working with your machine will result in much higher acceleration and higher top speeds! It is highly recommended that you modify your values to be half to two-thirds of your previous values initially, then re-tune them to your machine.

You have our sincere apologies from the whole development team about this need to re-tune your values, however this guarantees a true correlation between configuration values and actual accelerations and speeds actuated by your printers, meaning if you had a working configuration using a RAMPS or other board, similar values should now be adequately close with Redeem.

These new PRU firmwares also require additional software packages to compile properly (and they get compiled and sent to the PRU each time redeem starts or the endstop configurations are modified). Umikaze 2.1.1 will not currently fit on the 2GB variants of the Beaglebone - efforts are ongoing to try and reduce footprint while maintaining functionality, but in the meantime it is recommended that you run Umikaze 2.1.1 off the microSD card if you use a 2GB beaglebone.

Configuration changes

Below is a snippet with the main parameters that have changed in the new Redeem version, though there may be some that have slipped through the cracks here and there. We will try to maintain this list updated if any omissions are found, so make sure to check back here if you have difficulties, or ask for help in the Google+ community, or even better, on the Replicape Slack (invite link here

Sections with changes on default from master to staging:

[Delta]
Hez = no longer used in calculations
Ae/Be/Ce = effector offset no longer used.
A/B/C_tangential - no longer used.
A_angular, B_angular, C_angular = now used.


[Planner]
No Longer used:
max_length = 0.001
New:
# if total buffered time gets below (min_buffered_move_time) then wait for (print_move_buffer_wait) before moving again, (ms)
min_buffered_move_time = 100
No longer used:
min_speed_x = 0.005
min_speed_y = 0.005
min_speed_z = 0.005
min_speed_e = 0.01
min_speed_h = 0.01
min_speed_a = 0.01
min_speed_b = 0.01
min_speed_c = 0.01

Upgrading from Kamikaze 2.0.8

Liked the stability of 2.0.8? Umikaze 2.1.1 RC3 has been tested thoroughly for several weeks by multiple users on cartesian, delta and core XY geometries. Few negative reports were made, and most of those pertained to Redeem bugs which were quickly fixed.

To backup your configuration you'll need either: - a USB drive of 4GB or more that you can plug in while maintaining network connection (i.e. USB hub if you have a wifi dongle) - a microSD card of 4GB with an empty file system and that doesn't contain a BBB image on it.

You'll also need a little bit of patience, and a computer where you can run SSH to connect to the BBB.

First you need to tell Kamikaze where to find the SD card, and which folder it should be made accessible as. Linux folks will know this as a "mount command".

The SD card on the BBB (and BBBW) should always have the same device name, so the following command should work: mount /dev/mmcblk0p1 /mnt/ Now, any file or folder added, created or removed in /mnt/ will be on the SD card.

So, the interesting part is to select what to backup:

Redeem configuration

cp -r /etc/redeem/ /mnt/redeem_cfg_backup will copy the files from /etc/redeem/ into a new folder on the SD named "redeem_cfg_backup".

OctoPrint configuration + Timelapses

cp -r /home/octo/.octoprint/ /mnt/octoprint_cfg_backup will copy the Octoprint files (including timelapses) over.

STL and GCode files uploaded to OctoPrint

cp -r /usr/share/models /mnt/models will copy the files you've uploaded to Octoprint.

Network settings

Unfortunately the 2.0 and the 2.1 *kaze image series don't use the same network configurator - there's no easy way to port this over, so you're most likely going to want to re-do this part after installing 2.1.1. If you're a linux guru and defined your own IPtables rules, though, go ahead and save those, I'm assuming you know how to do that since you set them up in the first place :)

Upgrading from Kamikaze 2.1.0 with Redeem's master branch

Backup your files as per the instructions for Kamikaze 2.0.8 users above.

Network settings for 2.1.0 and 2.1.1 are compatible, so back those up too:

NetworkManager settings

cp -r /etc/NetworkManager /mnt/NetworkManager will copy the network configuration settings you have saved.

Upgrading from Kamikaze 2.1.0 with Redeem's development branch

Good news - your configuration should be up to date, depending on when was the last time you did a git pull for the develop branch! So, what you need to do first is to go to the /usr/src/redeem folder, then execute (when not printing, obviously!):

git pull && git checkout stating && python setup.py clean install && pip install nympy && systemctl restart redeem

Check that Redeem has restarted properly, and look for any messages about obsolete or undefined configuration options. If redeem hasn't restarted, use systemctl status redeem -l -n 100 as a means of checking for errors before redeem starts dumping things into the log file. Those error messages should be pretty explanatory. If not, come to #support on Slack and ask for help, we're always happy to help.

Once Redeem is starting again, finish backing up everything else, using the instructions for 2.0.8 and 2.1.0 and get ready for the flash.

Flashing

As always, the recommended way of flashing the Umikaze 2.1.1 image is to use Etcher.

You'll need a microSD card of 4GB at least, and be ready for the fact that all data on it will be erased to make room for the Umikaze image.

Insert the microSD into the BeagleBone when it's powered off.

Power up the BeagleBone, holding down the boot button (the button closes to the SD card slot) until you see all 4 LEDs light up. After up to a minute the cylon (or Knight-Rider) pattern should start going, indicating the flash is happening.

After Flashing

Now's the tricky bit, how do you make sure you get all your files back on, especially if you've mounted the BBB in a place it's hard to reach and not easy to connect to a computer? Well, the short answer is it's going to be a little tricky for a while yet. We have not yet worked out the best ways to get things properly upgraded in place.

If you were running 2.1.0 before, you should have your previous network settings if you were using a wifi network. There's a trick you can use if you're running Mac OSX or Linux, where before you flash you can insert your settings in the SD card's files in the proper location, so they get copied over with the flash.

Otherwise, your best bet is to manage to get your BBB tethered to a computer via USB (the mini or micro port next to the power connector, away from the replicape's power input). Whether you use Windows or a *nix system, you should be able to access it locally on the USB-ethernet bridge. Then use ssh or PuttY on Windows to logon (if 192.168.7.2 doesn't ping on Windows, try 192.168.6.2).