Difference between revisions of "TiLDA MK3"

Revision as of 20:44, 25 July 2016

Using your badge

Assembly

ToDo: How to attach screen and battery

Hardware

TiLDA comes with a long list of very useful hardware. Some might be obvious, but some are a bit hidden.

Colour LCD screen 320x240
Joystick and A/B/Menu Buttons
Wifi (cc3100)
Accelerometer
Compas
Buzzer
Battery
WS2812B aka "Neo Pixel"
MicroSD slot

Basic usage

After you have assembled your badge you can just use the tiny switch at the bottom of the screen to turn your badge on. Alternatively you can use any USB power source. If you turn your badge on for the first time (or if for some reason it has reset itself) you will get some on-screen information while we try to download the newest set of software.

If at any point you want to restart your badge you can just press the reset button at the back.

ToDo: Explain Home Screen

ToDo: Explain App Library

ToDo: Explain how to change your name

WiFi

Your TiLDA Badge has built-in wifi support. It should all just work if you're at the campsite, but if you're on your own network you might have to tell the badge about it. For more information please have a look here: WiFi

Charging

The badge charges via a microUSB socket, and takes about 2-3 hours for a full charge. The red charge LED next to the USB connector will extinguish when charging is complete

Nothing works! Help!

Don't worry, you can always "factory reset" your badge. Please follow these instructions: Resetting

Hacking your badge

One of the main goals of TiLDA is to make hacking it as easy as possible. We even want you to share your results! All you need to do so is a computer with USB and your badge. So sit down and get comfy.

The badge itself runs code written in the computer language Python which is run by a bit of software called Micropython.

If you want to get going and write your own code (of course you do!) start here: How to get started

The TiLDA badge supports all the default Micropython libraries and their documentation is an excellent starting point to get going. There are however some additional features we have added to the standard functions, so please have a look at TiLDA MK3/documentation for functions related to the WiFi and the LCD screen.

If you're already familiar with all this you can jump right into the topic of Apps. Apps can be shared via the EMF App Library or by copying files of and on via USB. If you want to know more about how this works go to TiLDA MK3/apps

In case you're more interested in what makes the hardware tick directly and your confident with C++ and microprocessors the you can go deeper and work directly on the micropython code that runs TiLDA: How to build the firmware from scratch

Badge API

See the following links for help and examples

- Microcontroller peripherals [1] (Timers, PWM, serial etc)

- uGFX (screen library)

- RTC (real time clock)

- ADC (analogue reading)

- Timer

Some ideas

- IRC relay

(feel free to add additional ideas, and create links new wiki pages to on-going projects, perhaps someone will want to contribute)

@@ Line 2: / Line 2: @@
 == Using your badge ==
-* Explaining buttons
+=== Assembly ===
+ToDo: How to attach screen and battery
+=== Hardware ===
+TiLDA comes with a long list of very useful hardware. Some might be obvious, but some are a bit hidden.
+* Colour LCD screen 320x240
+* Joystick and A/B/Menu Buttons
+* Wifi (cc3100)
+* Accelerometer
+* Compas
+* Buzzer
 * Battery
-* Hardware
+* WS2812B aka "Neo Pixel"
-* [[TiLDA MK3/wifi|WiFi]] How to set up the badge for your wifi and what to do if it doesn't work
+* MicroSD slot
-* [[TiLDA_MK3/reset|Resetting]] your badge if files become corrupted after editing.
-== Hacking your badge ==
+=== Basic usage ===
+After you have assembled your badge you can just use the tiny switch at the bottom of the screen to turn your badge on. Alternatively you can use any USB power source. If you turn your badge on for the first time (or if for some reason it has reset itself) you will get some on-screen information while we try to download the newest set of software.
-One of the main goals of this years TiLDA is to make it as easy as possible to hack it and share your results. All you need to do so is a computer with USB and your badge.
+If at any point you want to restart your badge you can just press the reset button at the back.
-The badge itself runs code written in the computer language [https://en.wikipedia.org/wiki/Python_(programming_language) Python] which is run by a bit of software called [https://micropython.org/ Micropython].
+ToDo: Explain Home Screen
-If you want to get going and write your own code (of course you do!) start here: [[TiLDA MK3/Get Started|How to get started]]
+ToDo: Explain App Library
-The TiLDA badge supports all the default Micropython libraries and their [http://docs.micropython.org/en/latest/pyboard/ documentation] is an excellent starting point to get going. There are however some  additional features we have added to the standard functions, so please have a look at [[TiLDA MK3/documentation]] for functions related to the [[TiLDA MK3/documentation/wifi|WiFi]] and the [[TiLDA MK3/documentation/ugfx|LCD screen]].
+ToDo: Explain how to change your name
-If you're already familiar with all this you can jump right into the topic of "Widgets". Widgets are equivalent to mobile phone apps and they can be shared via the EMF Widget Store. If you want to know more about how this works go to [[TiLDA MK3/widgets]]
+=== WiFi ===
+Your TiLDA Badge has built-in wifi support. It should all just work if you're at the campsite, but if you're on your own network you might have to tell the badge about it. For more information please have a look here: [[TiLDA MK3/wifi|WiFi]]
 === Charging ===
 The badge charges via a microUSB socket, and takes about 2-3 hours for a full charge. The red charge LED next to the USB connector will extinguish when charging is complete
+=== Nothing works! Help! ===
+Don't worry, you can always "factory reset" your badge. Please follow these instructions: [[TiLDA_MK3/reset|Resetting]]
 == Hacking your badge ==
+One of the main goals of TiLDA is to make hacking it as easy as possible. We even want you to share your results! All you need to do so is a computer with USB and your badge. So sit down and get comfy.
+The badge itself runs code written in the computer language [https://en.wikipedia.org/wiki/Python_(programming_language) Python] which is run by a bit of software called [https://micropython.org/ Micropython].
+If you want to get going and write your own code (of course you do!) start here: [[TiLDA MK3/Get Started|How to get started]]
+The TiLDA badge supports all the default Micropython libraries and their [http://docs.micropython.org/en/latest/pyboard/ documentation] is an excellent starting point to get going. There are however some  additional features we have added to the standard functions, so please have a look at [[TiLDA MK3/documentation]] for functions related to the [[TiLDA MK3/documentation/wifi|WiFi]] and the [[TiLDA MK3/documentation/ugfx|LCD screen]].
+If you're already familiar with all this you can jump right into the topic of Apps. Apps can be shared via the EMF App Library or by copying files of and on via USB. If you want to know more about how this works go to [[TiLDA MK3/apps]]
-[[TiLDA MK3/build|How to build the firmware from scratch]]
+In case you're more interested in what makes the hardware tick directly and your confident with C++ and microprocessors the you can go deeper and work directly on the micropython code that runs TiLDA: [[TiLDA MK3/build|How to build the firmware from scratch]]
 === Badge API ===