====== Getting Started with your Oak ======

Welcome to the Digistump wiki!

**The Wiki is open for collaborative editing!** 

**Please feel free to edit any page to make corrections or add valuable information - please DO NOT remove information or replace the tutorials we have provided.** Feel free to write an alternative tutorial for anything (and of course feel free to add new tutorials, projects, etc. and link them in the appropriate list on this page) and link them from this index. If your version is better we may replace the original. Since this is the first resource for many beginners we want to make sure any changes are accurate and contain the information they need.

Editing syntax can be found here: http://digistump.com/wiki/wiki/syntax

Please excuse the dust and the occasional incomplete tutorial. Please help us improve all of these things! 

Don't forget to checkout the forums as well: http://digistump.com/board/ - The forums are the best place to ask for help, share ideas, etc.

Thank you all, 

-Erik Kettenburg

==== Tutorials ====

**The Oak by Digistump - Getting started:**
  * **STEP 1:** [[oak:tutorials:connecting|Connecting your Oak for the first time]]
  * **STEP 2:** [[oak:tutorials:particle|Getting started with the Particle environment for the Oak]]
  * OR
  * **STEP 2:** [[oak:tutorials:arduino|Getting started with the Arduino environment for the Oak]]

  * [[oak:tutorials:wificonfig|Changing your Oak's wifi network]]


**Important Oak Tools**
  * **Oak WiFi Config:** http://digistu.mp/oakconfig (follow the Getting Started first if you have a new Oak!)
  * **OakTerm:** http://digistu.mp/oakterm (a tool set for working with Oaks and Particle)
  * **Digistump Dashboard:** http://digistu.mp/dashboard (a dashboard for Particle devices, including the Oak)


**Troubleshooting:**
  * [[oak:tutorials:local_update|Oak first update troubleshooting]]
  * [[oak:tutorials:serialupdate|Advanced Usage - First update over Serial]] or a simpler version: [[oak:serialupdate|Oak First Update over Serial]]
  * [[oak:tutorials:manual_claim|Particle claim troubleshooting - "No devices"]]
  * [[oak:tutorials:troubleshooting|Troubleshooting Tips]]
  * [[oak:tutorials:ws281x|Troubleshooting ws281x/NeoPixels RGB leds library tip]]


**Reference:**
  * [[oak:tutorials:api_reference|API and Function Reference for the Oak]]
  * [[oak:tutorials:headers|Soldering Headers to the Oak]]
  * [[oak:tutorials:pinout|Oak Pin Diagram and Notes]]
  * [[oak:tutorials:serialfirmware|Advanced Usage - Programming the Oak over Serial]]
  * [[oak:tutorials:internalURLs|Internal Oak URLs]]
  * [[oak:sources|Oak PCB Source Files]]
  * [[oak:reference:firmwareVersions|Oak Firmware Versions]]
  * [[oak:reference:howItWorks|Oak Firmware - How it all works]]
  * [[oak:reference:offline|Using an Oak without an internet connection - offline support]]
  * [[oak:tutorials:localserver|Oak with the Particle Local Server]]

**Advanced: Connecting the Oak to Serial Adapters:**
  * [[oak:tutorials:serialfirmware|Advanced Usage - Loading Firmware over Serial]]
  * [[oak:tutorials:serial|Connecting to Serial output of Oak using Bus Pirate]]
  * [[oak:tutorials:serial_through_arduino|Using an Arduino to restore the Oak/read serial data]]


**Oak Shields:** 
  * [[oak:tutorials:proto|Oak Proto Shield]]
  * [[oak:tutorials:levelshift|Oak Level Shifter Shield]]
  * [[oak:tutorials:oled|Oak OLED Shield]]
  * [[oak:tutorials:tft|Oak TFT LCD Shield]]
  * [[oak:tutorials:nrf|Oak nRF24L01+ Shield]]
  * [[oak:tutorials:gps|Oak GPS Shield]]
  * [[oak:tutorials:ble|Oak BLE Shield]]
  * [[oak:tutorials:bluetooth|Oak Bluetooth Shield]]
  * [[oak:tutorials:weather|Oak Weather Shield]]
  * [[oak:tutorials:relay|3.3V Relay Shield]]
  * [[oak:tutorials:lipo|LiPo Charger Shield]]
  * [[oak:tutorials:beta|Oak Beta WiFi Alarm Clock Shield]]


**Oak-Compatible/Digispark Shields:** 
  * [[digispark:tutorials:button|Button Shield]]
  * [[digispark:tutorials:smt| SMT Shield]]
  * [[digispark:tutorials:rgb|RGB LED Shield]]
  * [[digispark:tutorials:digiled|DigiLED Shield]]
  * [[digispark:tutorials:mosfet|MOSFET Shield]]
  * [[digispark:tutorials:grove|Grove Shield]]
  * [[digispark:tutorials:ir|IR Shield]]
  * [[digispark:tutorials:expander|Expander Shield]]
  * [[digispark:tutorials:eeprom|EEPROM Shield]]
  * [[digispark:tutorials:motor|Motor Shield]]
  * [[digispark:tutorials:wings|Wings Shield]]
  * [[digispark:tutorials:nunchuck|Nunchuck Shield]]
  * [[digispark:tutorials:rtc|Real Time Clock Shield]]
  * [[digispark:tutorials:temp|Temperature Sensor (1-wire) Shield]]
  * [[digispark:tutorials:robot|Robot (Car) Kit]]


**Starter and Ultimate Kit Lessons:** (**We'll give you store credit to write starter and ultimate kit lessons!** Find out more here: https://github.com/digistump/OakCore/issues/39)

  * [[oak:tutorials:kit_parts|Starter and Ultimate Kit Parts List]]
  * [[oak:tutorials:lesson_template|Format Template for Lessons]]

**Starter and Ultimate (suggested lessons, others welcome!):**
  * [[oak:tutorials:blink|First Blink]]
  * [[oak:tutorials:leds|LED Basics]]
  * [[oak:tutorials:advanced-leds|Advanced LEDs]]
  * [[oak:tutorials:rgb-led|RGB LED]]
  * [[oak:tutorials:button|Button Basics (both included button and button kit)]]
  * [[oak:tutorials:buzzer|Making noise with the buzzer]]
  * [[oak:tutorials:rollingball|Tilt Switch]]
  * [[oak:tutorials:photocell|Using a Photocell]]
  * [[oak:tutorials:servo|Using a Servo]]
  * [[oak:tutorials:stepper_motor|Controlling a Stepper Motor]]
  * [[oak:tutorials:ultrasonic|Ultrasonic Ranging US-100]]
  * [[oak:tutorials:ultrasonic_2|Ultrasonic Ranging HC-SR04]]
  * [[oak:tutorials:touch|Detecting Touch]]
  * [[oak:tutorials:onewiretemp|Temperature Sensing and the 1-Wire Bus]]
  * [[oak:tutorials:ir_receiver|Getting input from a remote (IR Receiver)]]
  * [[oak:tutorials:ir_interrupter|Detecting movement with an encoder/interrupter]]

**Ultimate Only (suggested lessons, others welcome!):**
  * [[oak:tutorials:pir|PIR: Detecting Motion]]
  * [[oak:tutorials:door_switch|Using the door switch]]
  * [[oak:tutorials:soil|Soil Moisture Sensors]]
  * [[oak:tutorials:breadboard_power|Powering the Oak with a 9v Battery and Breadboard Power Adapter]]

**Sending and receiving data**
  * [[oak:tutorials:particle-id-token|Accessing the Particle API]]
  * [[oak:tutorials:particle-variable|Getting data using Particle.variable()]]
  * [[oak:tutorials:particle-function|Sending data using Particle.function()]]
  * [[oak:tutorials:python-get|Using python to get data from the Oak]]
  * [[oak:tutorials:python-send|Using python to send data to the Oak]]

**Useful Project Tutorials**
  * [[oak:tutorials:oaksmokedetectorplus|Making your own Oak Smoke Detector+]]