Feedback requested: simplified software installation

I’ve spent my evening putting together a Model 01 support package for the Arduino IDE. If this works correctly, it should mean that getting from zero to working Model 01 firmware will be a lot simpler going forward.

  1. Download and install the Arduino IDE from https://arduino.cc

  2. Launch the Arduino IDE

  3. Open the “File” menu and click on “Preferences”

  4. Paste this URL into the 'Additional Board Manager URLs` box: https://raw.githubusercontent.com/keyboardio/boardsmanager/master/package_keyboardio_index.json
    and click ‘OK’ to close the dialog

  5. Open the ‘Tools’ menu, click on ‘Board’ and then click on ‘Boards Manager’

  6. Type ‘Keyboardio’ into the search box.

  7. Click ‘Install’

  8. Open the ‘Tools’ menu, click on ‘Board’ and then click on ‘Keyboardio Model 01’ – You may have to scroll through a long list of other boards to get there.

  9. Click on the “File” menu, click on the “Examples” submenu. Click on ‘Model01-Firmware’

  10. Click the ‘->’ Menu to compile the default firmware and flash it to your keyboard. (You will have to hold down the Prog key on your keyboard while clicking in order to enable reprogramming.)

Sooo… does that work for anybody?

7 Likes

crashing. I’ll look at this tomorrow, if I can. Schedule’s a bit tight, so realistically it may be Thursday.

1 Like

No worries. (This was the thing I was alluding to when I mentioned trying to put together something to save the newbies from having to touch git :wink:

Tried this under both Linux and Windows 8.1, with a fresh install of Arduino, both worked flawlessly, except for one tiny thing: I didn’t have a Settings menu, it was called Preferences, but otherwise following the steps got me a compiled firmware (I didn’t flash, but I assume that would have worked too).

Awesome!

So cool! No hardware to test with, but loaded it up and snooped through examples. So if I want Colemak I would edit this Model01-Firmware sketch and flash that, correct?

Correct!

Though, I heard @jesse talk about non-QWERTY layouts on IRC the other day, so it may become even easier than that. Nevertheless, to begin your customization journey, the Model01-Firmware sketch is the perfect start indeed.

2 Likes

Funny story. My menu item is called ‘Preferences’, too. I just wrote the wrong thing.

EDIT Fixed the original post

1 Like

While holding down the prog key, click on the right arrow in the sketch window menu bar to compile compile and install.

At this point I had a failure, and now I am ignoring dinner guests. :slight_smile: I’ll try to sort this later. Failure screen grab:

Oh! there may be a missing step. You may have to select a serial port under the tools menu.

1 Like

Yup! Selected the port, and the new firmware flashed. Now to customize it. :smile:

All re-customized. It’s worth noting that the port had to be re-selected when I renamed the sketch *.orig and started working in a copy.

I’m making notes here as much for my own reference later as for feedback to you.

2 Likes

Don’t have a keyboard yet so couldn’t test the final compile/flash step but everything else worked great.

Though for me the Preferences menu was under “Arduino” instead of “File”. I’m running Mac OS X High Sierra - Arduino v1.8.5

2 Likes

Took about 2 minutes including installing Arduino. Nicely commented!
To nitpick the instructions, ‘->’ is not a menu, but a toolbar button.

3 Likes

What kind of computer were you using? I don’t think anyone who uses a pc has commented yet. Thanks! :slight_smile:

Thinkpad X220 Tablet running Arch Linux. Should have mentioned :slight_smile:

1 Like

I’ll try my Windows PC later tonight.

1 Like

I’m working on detailed docs here:

https://github.com/keyboardio/Kaleidoscope/blob/jenndocs171007/doc/DRAFT_Intro_Docs.md#install-arduino-support

but I only have easy access to macs. If you have a chance, please let me know if the Windows instructions are similar enough to what I’ve written that people who aren’t familiar with Arduinos and are new to programming would be able to follow them. I have plans to go through the process on a PC to test them, but it’s going to be a few days before I can coordinate that.

Thanks!

Not having a keyboard, I couldn’t try to flash it, but following the instructions allowed me to compile without any errors or anything. Looks good, very simple for someone to follow. Thanks for putting it together!

This was on my Windows 10 PC.

2 Likes

Thanks! Hope you get yours soon!

Do you have ideas about what you would like to customize? I want to make sure I’m documenting the things people want to know. :slight_smile:

1 Like

Nothing real defined in my mind as far as customization plans. I’m sure I’ll be playing with the key map a bit, but I’m not sure where I’ll be moving everything quite yet.

There were some plugins that looked interesting (some of the “stock” plugins). There was also a Wave Pool plugin that I’d like to try out (New plugin: Water / Wavepool LED effect). I think what might be helpful would be a basic overview on how to include/exclude plugins in the sketch. There may already be some of that documentation out there, but I haven’t been motivated to really look that deep since I can’t actually use anything quite yet (though very anxious to start tinkering!).

1 Like