TiLDA MK3: Difference between revisions

From EMF Badge
Jump to navigation Jump to search
Line 50: Line 50:


== Badge API ==
== Badge API ==
=== Build-in ===
* [http://docs.micropython.org/en/latest/pyboard/ documentation] - General Micropython libarary
* [http://docs.micropython.org/en/latest/pyboard/ documentation] - General Micropython libarary
* [[TiLDA MK3/ugfx|uGFX]] - The TiLDA LCD colour screen
* [[TiLDA MK3/ugfx|uGFX]] - The TiLDA LCD colour screen

Revision as of 17:20, 26 July 2016

Using your badge

Assembly

ToDo: How to attach screen and battery

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. All you need to do so is a computer with USB and your badge.

Step-by-step: How to get started

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

For more information about the functions available please have a look at the Badge API section of this page.

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 and your confident with C++ and microprocessors then you can work directly with the micropython code that runs TiLDA: How to build the firmware from scratch

All code used is hosted on Github. Contributions and PR are very welcome!

Some ideas

Please share what you've done (or want to do) with others!

Badge API

Build-in

  • documentation - General Micropython libarary
  • uGFX - The TiLDA LCD colour screen
  • CC3100 - The wifi chip
  • RTC (real time clock)
  • ADC (analogue reading)
  • Timer
  • Microcontroller peripherals [1] (Timers, PWM, serial etc)

TiLDA Libraries

On top of the API above we have also created a bunch of helpful modules. If you go through the bootstrap process or use the App Library you should always have a full set of those on your badge. If for some reason this isn't the case download our repository from https://github.com/emfcamp/Mk3-Firmware and copy the lib folder onto your badge.

  • buttons
  • database
  • dialogs
  • filesystem
  • http_client
  • imu
  • wifi


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

Badge 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