Skip to content

Commit

Permalink
Add getting started section
Browse files Browse the repository at this point in the history
  • Loading branch information
monkbroc committed Jul 29, 2017
1 parent 9ab70d1 commit a969efe
Show file tree
Hide file tree
Showing 6 changed files with 71 additions and 11 deletions.
6 changes: 6 additions & 0 deletions docs.css
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,9 @@ body {
.content img {
max-width: 100%;
}

.content img.narrow-image {
max-width: 300px;
margin: 0 auto;
display: block;
}
Binary file added images/Carloop.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/Carloop_Basic.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/carloop_mark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,9 @@ <h1>Carloop Docs</h1>

<div class='content-root'>
<div class='menubar'>
<div class="section">
<a class="big button" href="https://store.carloop.io" target="_blank">Buy hardware</a>
</div>
<div class='menu section' role='flatdoc-menu'></div>
</div>
<div role='flatdoc-content' class='content'></div>
Expand Down
73 changes: 62 additions & 11 deletions index.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,75 @@
<p align="center">
<img src="https://github.com/carloop/hardware/blob/master/images/carloop%20with%20text.png?raw=true" alt="Carloop Logo"/>
<img src="images/carloop_mark.png" alt="Carloop Logo"/>
</p>

## What is Carloop?
# What is Carloop?
Carloop is an open source development kit that lets you easily access a car's CAN bus.

<a href="images/Photo2_750.jpg" data-caption="Carloop" data-fancybox="what-is-carloop">
<img src="images/Photo2_750.jpg" width="355"/>
</a>

## How do I get started?
Now that you have your Carloop, we understand you are anxious to connect it to your car and start developing some apps!

This page will walk you through how to get started and how to dig deeper into writing custom Carloop apps.

If you feel lost at any point, feel free to post in the Carloop community.

[Visit Carloop community >](https://community.carloop.io)

# Getting started with Carloop

To get started with Carloop, all you need is the following:
- Carloop Basic: [https://store.carloop.io/products/carloop-basic](https://goo.gl/QXREmq)
- OSX/Windows/Linux to program and flash

- [Carloop Basic](https://store.carloop.io/products/carloop-basic?utm_source=github&utm_campaign=docs)
- Computer with OSX/Windows/Linux to program and flash
- Micro-usb to USB cable

### The Hardware Pieces Explained
Carloop Basic is a pre-built kit which comes with a Carloop [https://store.carloop.io/products/carloop](https://goo.gl/qSsLV8) plus a Particle Photon. The Particle Photon is a microcontroller that comes with a CAN bus and a WiFi radio. We've looked at many options out there and this was the easiest development kit we could find!
## The hardware pieces explained

<p align="center">
<a href="images/Carloop Basic_Transparent_BG.png" data-caption="Carloop Basic" data-fancybox="what-is-carloop">
<img src="images/Carloop Basic_Transparent_BG.png" width="355"/>
### The Carloop board

Carloop board connects to the OBD-II port in any car.

<a href="images/Carloop.jpg" data-caption="Carloop board" data-fancybox="hardware">
<img src="images/Carloop.jpg" class="narrow-image">
</a>

### The microcontroller

You can plug the Particle Photon (Wi-Fi microcontroller), the Particle
Electron (3G cellular microcontroller) or the Red Bear Duo (Bluetooth +
Wi-Fi microcontroller) into the Carloop.

<a href="images/microcontrollers.jpg" data-caption="Microcontrollers compatible with Carloop" data-fancybox="hardware">
<img src="images/microcontrollers.jpg" class="narrow-image">
</a>
</p>

### Assembled Carloop

Plug in the microcontroller into the Carloop. Make sure to put the USB port towards the right.

<a href="images/Carloop_assembled.jpg" data-caption="Carloop with a Photon" data-fancybox="hardware">
<img src="images/Carloop_assembled.jpg" class="narrow-image">
</a>

## Get Ready to develop

You'll be using the tools from [Particle](https://www.particle.io) to
program the software in the Photon and Electron.

### Set up a Particle account

If you don't have a Particle account, take the time to
<a href="https://login.particle.io/signup" target="_blank">sign up for an account now</a>.

### Connect your device to the Internet

You'll need to connect your Particle Photon or Particle Electron to the
Internet so you can program it.

The easiest way to do that is to connect the device to USB and follow the
steps on the [Particle setup page](https://setup.particle.io).


# SUGGEST EDITS
Expand Down Expand Up @@ -57,3 +104,7 @@ Now you are ready to start programming your own app! Follow Hello World on the n
<img src="images/library_included.png">
</a>


## Pinout


0 comments on commit a969efe

Please sign in to comment.