index: add README.md and move README to index
When following the Github documentation for setting up a local build, the current index.md simply shows the text "README.md". I suspect this is due to a version difference, and anyway the site shouldn't have the same content as the repo. Rename README.md to index.md, to keep the site with the same functionality, and add a new README.md with some description. Signed-off-by: Sean Cross <sean@xobs.io>
This commit is contained in:
Sean Cross
parent
9ae776cd6e
commit
0deb9ad83a
2 changed files with 164 additions and 152 deletions
160
README.md
160
README.md
|
|
@ -1,155 +1,13 @@
|
|||
---
|
||||
layout: default
|
||||
title: A tiny ARM microprocessor which fits in your USB port.
|
||||
permalink: /
|
||||
---
|
||||
Tomu.im Site Source
|
||||
===================
|
||||
|
||||
# [Tomu, I'm](https://tomu.im)
|
||||
This is the source code to [Tomu.im](https://tomu.im)
|
||||
|
||||
[I'm Tomu](https://tomu.im), a tiny ARM microprocessor which fits in your USB
|
||||
port. I have two buttons and two LEDs!
|
||||
Developing Locally
|
||||
------------------
|
||||
|
||||
I'm fully open source, have a BOM of ~$10 (in individual quantities) and am
|
||||
constructable by hobbyists! Designed for 2-factor authentication or anything
|
||||
else you can think of.
|
||||
Following the [Github Documentation on Developing Locally](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/), perform the following steps on this repo once checked out:
|
||||
|
||||
{% raw %}
|
||||
<iframe style="min-height: 400px;" src="https://docs.google.com/presentation/d/1NV4QAr7nQg5OAjLGDzVBely9bvDAFhP1qIqw7IU5Wdk/embed?start=true&loop=true&delayms=3000" frameborder="0" width="100%" allowfullscreen="true" mozallowfullscreen="true" webkitallowfullscreen="true"></iframe>
|
||||
<br>
|
||||
<iframe width="560" height="315" src="https://www.youtube.com/embed/36zcE_C0K2k" frameborder="0" allowfullscreen></iframe>
|
||||
{% endraw %}
|
||||
|
||||
<hr><br><br>
|
||||
|
||||
# Getting Started!
|
||||
|
||||
* All Tomu boards have been loaded with a USB bootloader.
|
||||
* To get the USB bootloader to come up, you must connect the C pin to Vcc.
|
||||
* For further steps refer to this [Getting Started Guide](https://groups.google.com/forum/#!topic/tomu-discuss/r-LS0C7hjko)
|
||||
|
||||
<hr><br><br>
|
||||
|
||||
# Help us!
|
||||
|
||||
These are currently the top items which need to be done related to the Tomu. If
|
||||
you help out, [@mithro](https://github.com/mithro) will probably send you a
|
||||
Tomu device!
|
||||
|
||||
### Creating (or porting) a FOSS USB stack to EFM32HG
|
||||
|
||||
To make it easy for people to develop new applications for the Tomu, we need a
|
||||
good USB stack which is compatible with the EFM32HG.
|
||||
|
||||
There are a couple of possible options:
|
||||
|
||||
* [Porting LUFA](https://github.com/im-tomu/tomu-samples/issues/2) - Someone
|
||||
seems to have already started the EFM32 series, just not the EFM32HG.
|
||||
* [Port ChibiOS](https://github.com/im-tomu/tomu-samples/issues/11)
|
||||
* Other options?
|
||||
|
||||
### Creating (or porting) U2F / FIDO compatible firmware
|
||||
|
||||
* [More Info](https://github.com/im-tomu/tomu-samples/issues/3)
|
||||
|
||||
The ultimate goal of the Tomu is to be used as a 2nd factor authentication
|
||||
device. For this to work [someone needs to write firmware compatible with the FIDO
|
||||
protocol](https://github.com/im-tomu/tomu-samples/issues/3).
|
||||
|
||||
There are already a bunch of things which could make this easier:
|
||||
[micro-ecc](https://github.com/kmackay/micro-ecc),
|
||||
[Nitrokey](https://github.com/Nitrokey),
|
||||
[u2f-zero](https://github.com/conorpp/u2f-zero) and
|
||||
[stm32-u2f](https://github.com/avivgr/stm32-u2f).
|
||||
|
||||
|
||||
### QEmu Emulation of the EFM32HG
|
||||
|
||||
* [Code Repo](https://github.com/im-tomu/qemu)
|
||||
|
||||
We would like to have good emulation of the features in the EFM32HG309
|
||||
processor so that people can write software for the board without having to
|
||||
have the hardware.
|
||||
|
||||
The biggest part of this is the emulation of the USB stack.
|
||||
|
||||
### Creation of Tomu bootloader programming rig
|
||||
|
||||
The EFM32HG comes with a bootloader which doesn't work without an external
|
||||
crystal. We thus need to replace the bootloader with a version that does. It
|
||||
would be good to have a standard rig which allows programming of multiple Tomu
|
||||
boards (a whole panel) at once.
|
||||
|
||||
<hr><br><br>
|
||||
|
||||
# Contact
|
||||
|
||||
* [Announcement mailing list](https://groups.google.com/forum/#!forum/tomu-announce/join) - Low traffic list for announcements.
|
||||
* [Discussion mailing list](https://groups.google.com/forum/#!forum/tomu-discuss/join) - List for discussing development / new features / etc.
|
||||
* [IRC Channel - irc://irc.freenode.net/#tomu](https://webchat.freenode.net/?channels=#tomu) - IRC channel for discussing anything related to the project.
|
||||
|
||||
<hr><br><br>
|
||||
|
||||
# Tomu Hardware
|
||||
|
||||
Built out of a 3d printed part + 2 layer "thin" PCB (0.4mm, 0.6mm or 0.8mm
|
||||
thick).
|
||||
|
||||
Both boards have:
|
||||
|
||||
* 6mil traces
|
||||
* 6mil clearance
|
||||
* 0.3mm drill / 0.6mm vias
|
||||
|
||||
All Tomu boards have:
|
||||
|
||||
* At least 2 different color LEDs
|
||||
* At least 2 touch buttons
|
||||
|
||||
## Tomu
|
||||
|
||||
* **Status**: Hardware complete, simple flashing firmware working. Needs proper
|
||||
firmware.
|
||||
* [GitHub Repository](https://github.com/im-tomu/tomu-hardware)
|
||||
|
||||
### Specs
|
||||
|
||||
* Uses a Silicon Labs Happy Gecko EFM32HG309
|
||||
- 25MHz ARM Cortex-M0+
|
||||
- 8kb^ RAM
|
||||
- 64kb^ Flash
|
||||
- USB 2.0
|
||||
|
||||
* Literally 12 parts
|
||||
* BOM ~$10 USD from Digikey (in individual quantities)
|
||||
|
||||
### Gerbers
|
||||
|
||||
* [v0.2](https://github.com/im-tomu/tomu-hardware/tree/master/releases/v0.2/gerbers)
|
||||
|
||||
The important thing to note is that you need a PCB that is 0.8mm thickness **or
|
||||
less**. The default thickness is normally 1.0mm and **1.0mm is too thick**.
|
||||
|
||||
These gerbers should be possible with the following manufacturers:
|
||||
|
||||
* (Tested) [Hackvana](http://www.hackvana.com/store/)
|
||||
* (Undergoing testing) [DirtyPCB](http://dirtypcbs.com/store/pcbs)
|
||||
* (Undergoing testing) [Seeed Studio](https://www.seeedstudio.com/fusion_pcb.html)
|
||||
* (Yet to be ordered) [OHS Park - 2 Layer 2oz 0.8mm Service](http://docs.oshpark.com/services/two-layer-hhdc/)
|
||||
|
||||
|
||||
# License
|
||||
|
||||
The Tomu hardware is under your choice of:
|
||||
|
||||
* the "Creative Commons Attribution-ShareAlike 4.0 International License"
|
||||
(CC BY-SA 4.0) full text of this license is included in the LICENSE file
|
||||
and a copy can also be found at
|
||||
[http://creativecommons.org/licenses/by-sa/4.0/](http://creativecommons.org/licenses/by-sa/4.0/)
|
||||
* the "TAPR Open Hardware License" full text of this license is included
|
||||
in the LICENSE file and a copy can also be found at
|
||||
[http://www.tapr.org/OHL](http://www.tapr.org/OHL)
|
||||
|
||||
Software for Tomu is under various licenses, please consult the license
|
||||
included with the code.
|
||||
|
||||
|
||||
1. Ensure ruby is installed. On Ubuntu/Debian, run sudo apt install ruby ruby-dev make gcc libcurl3 autoconf libz-dev
|
||||
1. bundle install --path vendor/bundle
|
||||
1. bundle exec jekyll serve
|
||||
1
index.md
1
index.md
|
|
@ -1 +0,0 @@
|
|||
README.md
|
||||
155
index.md
Normal file
155
index.md
Normal file
|
|
@ -0,0 +1,155 @@
|
|||
---
|
||||
layout: default
|
||||
title: A tiny ARM microprocessor which fits in your USB port.
|
||||
permalink: /
|
||||
---
|
||||
|
||||
# [Tomu, I'm](https://tomu.im)
|
||||
|
||||
[I'm Tomu](https://tomu.im), a tiny ARM microprocessor which fits in your USB
|
||||
port. I have two buttons and two LEDs!
|
||||
|
||||
I'm fully open source, have a BOM of ~$10 (in individual quantities) and am
|
||||
constructable by hobbyists! Designed for 2-factor authentication or anything
|
||||
else you can think of.
|
||||
|
||||
{% raw %}
|
||||
<iframe style="min-height: 400px;" src="https://docs.google.com/presentation/d/1NV4QAr7nQg5OAjLGDzVBely9bvDAFhP1qIqw7IU5Wdk/embed?start=true&loop=true&delayms=3000" frameborder="0" width="100%" allowfullscreen="true" mozallowfullscreen="true" webkitallowfullscreen="true"></iframe>
|
||||
<br>
|
||||
<iframe width="560" height="315" src="https://www.youtube.com/embed/36zcE_C0K2k" frameborder="0" allowfullscreen></iframe>
|
||||
{% endraw %}
|
||||
|
||||
<hr><br><br>
|
||||
|
||||
# Getting Started!
|
||||
|
||||
* All Tomu boards have been loaded with a USB bootloader.
|
||||
* To get the USB bootloader to come up, you must connect the C pin to Vcc.
|
||||
* For further steps refer to this [Getting Started Guide](https://groups.google.com/forum/#!topic/tomu-discuss/r-LS0C7hjko)
|
||||
|
||||
<hr><br><br>
|
||||
|
||||
# Help us!
|
||||
|
||||
These are currently the top items which need to be done related to the Tomu. If
|
||||
you help out, [@mithro](https://github.com/mithro) will probably send you a
|
||||
Tomu device!
|
||||
|
||||
### Creating (or porting) a FOSS USB stack to EFM32HG
|
||||
|
||||
To make it easy for people to develop new applications for the Tomu, we need a
|
||||
good USB stack which is compatible with the EFM32HG.
|
||||
|
||||
There are a couple of possible options:
|
||||
|
||||
* [Porting LUFA](https://github.com/im-tomu/tomu-samples/issues/2) - Someone
|
||||
seems to have already started the EFM32 series, just not the EFM32HG.
|
||||
* [Port ChibiOS](https://github.com/im-tomu/tomu-samples/issues/11)
|
||||
* Other options?
|
||||
|
||||
### Creating (or porting) U2F / FIDO compatible firmware
|
||||
|
||||
* [More Info](https://github.com/im-tomu/tomu-samples/issues/3)
|
||||
|
||||
The ultimate goal of the Tomu is to be used as a 2nd factor authentication
|
||||
device. For this to work [someone needs to write firmware compatible with the FIDO
|
||||
protocol](https://github.com/im-tomu/tomu-samples/issues/3).
|
||||
|
||||
There are already a bunch of things which could make this easier:
|
||||
[micro-ecc](https://github.com/kmackay/micro-ecc),
|
||||
[Nitrokey](https://github.com/Nitrokey),
|
||||
[u2f-zero](https://github.com/conorpp/u2f-zero) and
|
||||
[stm32-u2f](https://github.com/avivgr/stm32-u2f).
|
||||
|
||||
|
||||
### QEmu Emulation of the EFM32HG
|
||||
|
||||
* [Code Repo](https://github.com/im-tomu/qemu)
|
||||
|
||||
We would like to have good emulation of the features in the EFM32HG309
|
||||
processor so that people can write software for the board without having to
|
||||
have the hardware.
|
||||
|
||||
The biggest part of this is the emulation of the USB stack.
|
||||
|
||||
### Creation of Tomu bootloader programming rig
|
||||
|
||||
The EFM32HG comes with a bootloader which doesn't work without an external
|
||||
crystal. We thus need to replace the bootloader with a version that does. It
|
||||
would be good to have a standard rig which allows programming of multiple Tomu
|
||||
boards (a whole panel) at once.
|
||||
|
||||
<hr><br><br>
|
||||
|
||||
# Contact
|
||||
|
||||
* [Announcement mailing list](https://groups.google.com/forum/#!forum/tomu-announce/join) - Low traffic list for announcements.
|
||||
* [Discussion mailing list](https://groups.google.com/forum/#!forum/tomu-discuss/join) - List for discussing development / new features / etc.
|
||||
* [IRC Channel - irc://irc.freenode.net/#tomu](https://webchat.freenode.net/?channels=#tomu) - IRC channel for discussing anything related to the project.
|
||||
|
||||
<hr><br><br>
|
||||
|
||||
# Tomu Hardware
|
||||
|
||||
Built out of a 3d printed part + 2 layer "thin" PCB (0.4mm, 0.6mm or 0.8mm
|
||||
thick).
|
||||
|
||||
Both boards have:
|
||||
|
||||
* 6mil traces
|
||||
* 6mil clearance
|
||||
* 0.3mm drill / 0.6mm vias
|
||||
|
||||
All Tomu boards have:
|
||||
|
||||
* At least 2 different color LEDs
|
||||
* At least 2 touch buttons
|
||||
|
||||
## Tomu
|
||||
|
||||
* **Status**: Hardware complete, simple flashing firmware working. Needs proper
|
||||
firmware.
|
||||
* [GitHub Repository](https://github.com/im-tomu/tomu-hardware)
|
||||
|
||||
### Specs
|
||||
|
||||
* Uses a Silicon Labs Happy Gecko EFM32HG309
|
||||
- 25MHz ARM Cortex-M0+
|
||||
- 8kb^ RAM
|
||||
- 64kb^ Flash
|
||||
- USB 2.0
|
||||
|
||||
* Literally 12 parts
|
||||
* BOM ~$10 USD from Digikey (in individual quantities)
|
||||
|
||||
### Gerbers
|
||||
|
||||
* [v0.2](https://github.com/im-tomu/tomu-hardware/tree/master/releases/v0.2/gerbers)
|
||||
|
||||
The important thing to note is that you need a PCB that is 0.8mm thickness **or
|
||||
less**. The default thickness is normally 1.0mm and **1.0mm is too thick**.
|
||||
|
||||
These gerbers should be possible with the following manufacturers:
|
||||
|
||||
* (Tested) [Hackvana](http://www.hackvana.com/store/)
|
||||
* (Undergoing testing) [DirtyPCB](http://dirtypcbs.com/store/pcbs)
|
||||
* (Undergoing testing) [Seeed Studio](https://www.seeedstudio.com/fusion_pcb.html)
|
||||
* (Yet to be ordered) [OHS Park - 2 Layer 2oz 0.8mm Service](http://docs.oshpark.com/services/two-layer-hhdc/)
|
||||
|
||||
|
||||
# License
|
||||
|
||||
The Tomu hardware is under your choice of:
|
||||
|
||||
* the "Creative Commons Attribution-ShareAlike 4.0 International License"
|
||||
(CC BY-SA 4.0) full text of this license is included in the LICENSE file
|
||||
and a copy can also be found at
|
||||
[http://creativecommons.org/licenses/by-sa/4.0/](http://creativecommons.org/licenses/by-sa/4.0/)
|
||||
* the "TAPR Open Hardware License" full text of this license is included
|
||||
in the LICENSE file and a copy can also be found at
|
||||
[http://www.tapr.org/OHL](http://www.tapr.org/OHL)
|
||||
|
||||
Software for Tomu is under various licenses, please consult the license
|
||||
included with the code.
|
||||
|
||||
|
||||
Loading…
Reference in a new issue