# Feedback requested: simplified software installation

**URL:** <https://community.keyboard.io/t/feedback-requested-simplified-software-installation/348>\
**Category:** Programming\
**Created:** [October 4, 2017, 5:42am UTC](https://community.keyboard.io/t/feedback-requested-simplified-software-installation/348 "2017-10-04T05:42:53Z")\
**Posts on this page:** 20\
**Page:** 1

<div class="post-metadata">

**Author:** ![jesse](https://yyz1.discourse-cdn.com/flex031/user_avatar/community.keyboard.io/jesse/32/361_2.png) [@jesse](https://community.keyboard.io/u/jesse)\
**Post date:** [October 4, 2017, 5:42am UTC](https://community.keyboard.io/t/feedback-requested-simplified-software-installation/348/1 "2017-10-04T05:42:54Z")

</div>

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](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](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?

---

<div class="post-metadata">

**Author:** ![Jennigma](https://yyz1.discourse-cdn.com/flex031/user_avatar/community.keyboard.io/jennigma/32/353_2.png) [@Jennigma](https://community.keyboard.io/u/Jennigma)\
**Post date:** [October 4, 2017, 6:03am UTC](https://community.keyboard.io/t/feedback-requested-simplified-software-installation/348/2 "2017-10-04T06:03:43Z")

</div>

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

---

<div class="post-metadata">

**Author:** ![jesse](https://yyz1.discourse-cdn.com/flex031/user_avatar/community.keyboard.io/jesse/32/361_2.png) [@jesse](https://community.keyboard.io/u/jesse)\
**Post date:** [October 4, 2017, 6:04am UTC](https://community.keyboard.io/t/feedback-requested-simplified-software-installation/348/3 "2017-10-04T06:04:40Z")

</div>

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 😉

---

<div class="post-metadata">

**Author:** ![algernon](https://yyz1.discourse-cdn.com/flex031/user_avatar/community.keyboard.io/algernon/32/4404_2.png) [@algernon](https://community.keyboard.io/u/algernon)\
**Post date:** [October 4, 2017, 9:07am UTC](https://community.keyboard.io/t/feedback-requested-simplified-software-installation/348/4 "2017-10-04T09:07:17Z")

</div>

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!

---

<div class="post-metadata">

**Author:** ![arley](https://yyz1.discourse-cdn.com/flex031/user_avatar/community.keyboard.io/arley/32/56_2.png) [@arley](https://community.keyboard.io/u/arley)\
**Post date:** [October 4, 2017, 1:11pm UTC](https://community.keyboard.io/t/feedback-requested-simplified-software-installation/348/5 "2017-10-04T13:11:51Z")

</div>

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?

---

<div class="post-metadata">

**Author:** ![algernon](https://yyz1.discourse-cdn.com/flex031/user_avatar/community.keyboard.io/algernon/32/4404_2.png) [@algernon](https://community.keyboard.io/u/algernon)\
**Post date:** [October 4, 2017, 3:10pm UTC](https://community.keyboard.io/t/feedback-requested-simplified-software-installation/348/6 "2017-10-04T15:10:24Z")

</div>

> [@arley](#):
>
> 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.

---

<div class="post-metadata">

**Author:** ![jesse](https://yyz1.discourse-cdn.com/flex031/user_avatar/community.keyboard.io/jesse/32/361_2.png) [@jesse](https://community.keyboard.io/u/jesse)\
**Post date:** [October 4, 2017, 5:22pm UTC](https://community.keyboard.io/t/feedback-requested-simplified-software-installation/348/7 "2017-10-04T17:22:37Z")

</div>

> [@algernon](#):
>
> except for one tiny thing: I didn’t have a Settings menu, it was called Preferences

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

_EDIT_ Fixed the original post

---

<div class="post-metadata">

**Author:** ![Jennigma](https://yyz1.discourse-cdn.com/flex031/user_avatar/community.keyboard.io/jennigma/32/353_2.png) [@Jennigma](https://community.keyboard.io/u/Jennigma)\
**Post date:** [October 5, 2017, 12:57am UTC](https://community.keyboard.io/t/feedback-requested-simplified-software-installation/348/8 "2017-10-05T00:57:18Z")

</div>

> [@jesse](#):
>
> > Launch the Arduino IDE
> 
> When I opened the zip file on my mac it extracted a file named “Arduino.app” which I infer is the IDE, but would want to clarify in the docs. I will try on a PC another time.
> 
> When I launched the app it opened a default sketch. when I dismissed it the app closed. Will need to document a note about ignoring the default sketch.
> 
> > Open the “File” menu and click on “Preferences”
> 
> The “Preferences” menu option is under the Arduino menu, not File.
> 
> > Paste this URL into the 'Additional Board Manager URLs` box: [https://raw.githubusercontent.com/keyboardio/boardsmanager/master/package\_keyboardio\_index.json](https://raw.githubusercontent.com/keyboardio/boardsmanager/master/package_keyboardio_index.json)
> 
> > and click ‘OK’ to close the dialog
> 
> > Open the ‘Tools’ menu, click on ‘Board’ and then click on ‘Boards Manager’
> 
> > Type ‘Keyboardio’ into the search box.
> 
> > Click ‘Install’
> 
> the “Install” button doesn’t show up until you click on the “keyboardio by Keyboardio” info in the results block, which is not obviously clickable.
> 
> Need a note to close the Boards Manager window
> 
> > 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.
> 
> My menu had two entries for “Board: Arduino/Genuine Uno \>” which appear to have identical lists.
> 
> > Click on the “File” menu, click on the “Examples” submenu. Click on ‘Model01-Firmware’
> 
> > 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.)

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. 🙂 I’ll try to sort this later. Failure screen grab:

 ![Arduino installer fail msg](https://canada1.discourse-cdn.com/flex031/uploads/keyboard/original/1X/1cd016f11abe889bde9516a9bebf1f33ad3531aa.png)

---

<div class="post-metadata">

**Author:** ![jesse](https://yyz1.discourse-cdn.com/flex031/user_avatar/community.keyboard.io/jesse/32/361_2.png) [@jesse](https://community.keyboard.io/u/jesse)\
**Post date:** [October 5, 2017, 1:15am UTC](https://community.keyboard.io/t/feedback-requested-simplified-software-installation/348/9 "2017-10-05T01:15:26Z")

</div>

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

---

<div class="post-metadata">

**Author:** ![Jennigma](https://yyz1.discourse-cdn.com/flex031/user_avatar/community.keyboard.io/jennigma/32/353_2.png) [@Jennigma](https://community.keyboard.io/u/Jennigma)\
**Post date:** [October 5, 2017, 5:09am UTC](https://community.keyboard.io/t/feedback-requested-simplified-software-installation/348/10 "2017-10-05T05:09:29Z")

</div>

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

---

<div class="post-metadata">

**Author:** ![Jennigma](https://yyz1.discourse-cdn.com/flex031/user_avatar/community.keyboard.io/jennigma/32/353_2.png) [@Jennigma](https://community.keyboard.io/u/Jennigma)\
**Post date:** [October 5, 2017, 5:22am UTC](https://community.keyboard.io/t/feedback-requested-simplified-software-installation/348/11 "2017-10-05T05:22:40Z")

</div>

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.

---

<div class="post-metadata">

**Author:** ![mikepugh](https://yyz1.discourse-cdn.com/flex031/user_avatar/community.keyboard.io/mikepugh/32/369_2.png) [@mikepugh](https://community.keyboard.io/u/mikepugh)\
**Post date:** [October 5, 2017, 12:03pm UTC](https://community.keyboard.io/t/feedback-requested-simplified-software-installation/348/12 "2017-10-05T12:03:39Z")

</div>

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

---

<div class="post-metadata">

**Author:** ![mikekuehn](https://yyz1.discourse-cdn.com/flex031/user_avatar/community.keyboard.io/mikekuehn/32/61_2.png) [@mikekuehn](https://community.keyboard.io/u/mikekuehn)\
**Post date:** [October 7, 2017, 2:22pm UTC](https://community.keyboard.io/t/feedback-requested-simplified-software-installation/348/13 "2017-10-07T14:22:47Z")

</div>

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

---

<div class="post-metadata">

**Author:** ![Jennigma](https://yyz1.discourse-cdn.com/flex031/user_avatar/community.keyboard.io/jennigma/32/353_2.png) [@Jennigma](https://community.keyboard.io/u/Jennigma)\
**Post date:** [October 7, 2017, 4:53pm UTC](https://community.keyboard.io/t/feedback-requested-simplified-software-installation/348/14 "2017-10-07T16:53:31Z")

</div>

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

---

<div class="post-metadata">

**Author:** ![mikekuehn](https://yyz1.discourse-cdn.com/flex031/user_avatar/community.keyboard.io/mikekuehn/32/61_2.png) [@mikekuehn](https://community.keyboard.io/u/mikekuehn)\
**Post date:** [October 7, 2017, 5:28pm UTC](https://community.keyboard.io/t/feedback-requested-simplified-software-installation/348/15 "2017-10-07T17:28:52Z")

</div>

Thinkpad X220 Tablet running Arch Linux. Should have mentioned 🙂

---

<div class="post-metadata">

**Author:** ![ejinks4](https://avatars.discourse-cdn.com/v4/letter/e/cdc98d/32.png) [@ejinks4](https://community.keyboard.io/u/ejinks4)\
**Post date:** [October 7, 2017, 8:13pm UTC](https://community.keyboard.io/t/feedback-requested-simplified-software-installation/348/16 "2017-10-07T20:13:54Z")

</div>

I’ll try my Windows PC later tonight.

---

<div class="post-metadata">

**Author:** ![Jennigma](https://yyz1.discourse-cdn.com/flex031/user_avatar/community.keyboard.io/jennigma/32/353_2.png) [@Jennigma](https://community.keyboard.io/u/Jennigma)\
**Post date:** [October 7, 2017, 11:19pm UTC](https://community.keyboard.io/t/feedback-requested-simplified-software-installation/348/17 "2017-10-07T23:19:15Z")

</div>

I’m working on detailed docs here:

[https://github.com/keyboardio/Kaleidoscope/blob/jenndocs171007/doc/DRAFT\_Intro\_Docs.md#install-arduino-support](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!

---

<div class="post-metadata">

**Author:** ![ejinks4](https://avatars.discourse-cdn.com/v4/letter/e/cdc98d/32.png) [@ejinks4](https://community.keyboard.io/u/ejinks4)\
**Post date:** [October 8, 2017, 2:18am UTC](https://community.keyboard.io/t/feedback-requested-simplified-software-installation/348/18 "2017-10-08T02:18:20Z")

</div>

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.

---

<div class="post-metadata">

**Author:** ![Jennigma](https://yyz1.discourse-cdn.com/flex031/user_avatar/community.keyboard.io/jennigma/32/353_2.png) [@Jennigma](https://community.keyboard.io/u/Jennigma)\
**Post date:** [October 8, 2017, 2:41am UTC](https://community.keyboard.io/t/feedback-requested-simplified-software-installation/348/19 "2017-10-08T02:41:53Z")

</div>

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. 🙂

---

<div class="post-metadata">

**Author:** ![ejinks4](https://avatars.discourse-cdn.com/v4/letter/e/cdc98d/32.png) [@ejinks4](https://community.keyboard.io/u/ejinks4)\
**Post date:** [October 8, 2017, 3:04am UTC](https://community.keyboard.io/t/feedback-requested-simplified-software-installation/348/20 "2017-10-08T03:04:18Z")

</div>

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](https://community.keyboard.io/t/new-plugin-water-wavepool-led-effect/305/15)). 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!).

[Next page](https://community.keyboard.io/t/feedback-requested-simplified-software-installation/348.md?page=2)
