veeOp Wiki - New pages [en]

REST API

2013-10-16T17:06:09Z

Doug: /* Per node-i2c module readme on Raspbian */

== Installing & Configuring Node (on Raspbian) ==

I used a guide @ [http://blog.rueedlinger.ch/2013/03/raspberry-pi-and-nodejs-basic-setup/ rueedlinger.ch] for installing an up-to-date Node.js, as the one from apt-get was quite out of date. Also, I didn't have luck with Node 10.5, so I went with Node 10.2.

You download binaries, so it's very straight forward.

sudo mkdir /opt/node
wget http://nodejs.org/dist/v0.10.2/node-v0.10.2-linux-arm-pi.tar.gz
tar xvzf node-v0.10.2-linux-arm-pi.tar.gz
sudo cp -r node-v0.10.2-linux-arm-pi/* /opt/node

Change the default profile with

sudo nano /etc/profile

And add these lines before "export PATH"

NODE_JS_HOME="/opt/node"
NODE_PATH="/opt/node"
PATH="$NODE_JS_HOME/bin/:$PATH"

And then log out and back in.

=== Installing NPM Modules ===

Install "forever" as a global npm module. To do this you might have to set the proper path as root. "sudo su" is used here as a stop gap / work-around, I don't recommend it as a habit. If I could've done it a different way here, I would've. However, this worked so it's worth the two lines as su.

sudo su
PATH=/opt/node/bin/:$PATH
npm install forever -g
exit

(If you install it local first, before that, you might have to uninstall both, and then install globally)

=== Per node-i2c module readme on Raspbian ===

After installing i2c, you'll need to configure that the modules are available.

sudo vi /etc/modules

And add

i2c-bcm2708
i2c-dev

Then edit

sudo nano /etc/modprobe.d/raspi-blacklist.conf

And comment out the i2c module so it looks like:

# blacklist i2c-bcm2708

Load the kernel module

sudo modprobe i2c-bcm2708

...You may need to reboot at this point.

Check that it's there

pi@raspberrypi ~ $ sudo ls /dev/i2c-* -l
crw------- 1 root root 89, 0 Oct 23 20:03 /dev/i2c-0
crw------- 1 root root 89, 1 Oct 23 20:03 /dev/i2c-1

==== Giving proper permissions to the i2c devices ====

Here we modify our udev rules in order to modify the i2c device to be owned by root. In the usermod command replace "pi" with the username of your choice, if you so wish.

sudo groupadd i2c
sudo usermod -aG i2c pi
sudo echo 'KERNEL=="i2c-[0-9]*", GROUP="i2c"' >> /etc/udev/rules.d/10-local_i2c_group.rules

== Setting up syslog ==

The server process uses node-syslog to get the logging done, which in turn requires some setup on the syslogd on your system. Again note, if you're using a pre-configured distro, this will already be setup for you.

In my example configuration in Pidora, we'll edit our syslog.conf

nano /etc/rsyslog.conf

And we'll add these two lines:

# Save veeOP daemon messages to veeop.log
local5.* /var/log/veeop.conf

Then restart the daemon with

sudo service syslog restart

You'll probably also want to rotate this log, go and edit instructions for syslog

nano /etc/logrotate.d/veeop

And fill it with:

/var/log/veeop.log {
missingok
notifempty
size 5M
yearly
create 0600 root root
}

Frequently Asked Questions

2013-10-14T14:39:35Z

Doug: Created page with "* '''What does the veeOP do?''' : The veeOP's core functionality is to smoothly power down your Raspberry Pi while installed in your car/truck/boat -- based on the state of t..."

* '''What does the veeOP do?'''

: The veeOP's core functionality is to smoothly power down your Raspberry Pi while installed in your car/truck/boat -- based on the state of the ignition. It senses the state of the ignition and communicates with the Raspberry Pi letting it know that it's time to shutdown. That's it's main function, but, it's designed to be extended by you! So you can fit it into your application. This wiki here provides lots of information about how you can further extend it's functionality and get to doing "cooler stuff".

* '''No, but, what's it DO? Like, why do I want to do this?'''

: The veeOP is really a platform for a Raspberry Pi "carputer" -- a computer you run in your car. People use carputers from everything to media centers, to ODB-II (on-board diagnostics) interfaces, to advanced GPS tracking devices. And everything in between. If you've ever had an idea of what you could make better in your car electronically -- there's a chance you can do it with a carputer.

User Manual:Index

2013-10-14T14:33:58Z

Doug: Created page with "== First time setup == So! You just opened up your veeOP package. Let's fire 'er up and get up and running! First things first, don't install it in your car yet. Let's test ..."

== First time setup ==

So! You just opened up your veeOP package. Let's fire 'er up and get up and running!

First things first, don't install it in your car yet. Let's test it at your desk first, and make sure everything is going well. This way, you don't have to put it in, take it out if things aren't going right, right off the bat.

Downloads

2013-10-11T18:02:57Z

Doug:

Download Everything that you need to get your veeOP going with your Raspberry pi!

== Pre-configured Distros ==

Download the distro of your choice

== veeOP REST API ==

: ''Main Article:'' [[REST API]]

[https://code.google.com/p/raspi-vop/ Available on Google Code]

The veeOP REST API is written in Node.js, and like everything else about the veeOP is completely open source.

But, interfacing with it is easy -- and easy enough to do almost any programming language. That's why we made it a RESTful API.

== Arduino Code & I²C API ==

: ''Main Article:'' [[I²C API]]

[https://code.google.com/p/arduino-vop/ Available on Google Code]

It's meant to be extensible! Available as an Arduino Library, it's easy to add functionality to the on-board Arduino compatible, and extend the functionality of your veeOP, and add custom electronics.

Application Ideas

2013-10-11T17:38:02Z

Doug:

We've just finishing developing the core veeOP components, and next we'll continue creating integrated application for veeOP -- the application specific ideas that will bring Raspberry Pi to life in your vehicle.

We're planning to flesh these out into entire kits you can purchase, or the instructions to complete these projects all on your own.

== Media Center ==

# Install your veeOP
# Add WiFi USB Dongle
# Add XBMC
# Write a script to detect your home WiFi.
# Add btsync to sync music from home music collection.
# Music syncs while parked on the street / in your garage.
# Add a script to turn off your raspberry pi only when the sync is complete.
# Use an XBMC remote application to play your always-in-sync music collection in your car

== Mobile Web Applications ==

# Install your veeOP
# Add WiFi USB Dongle
# Setup tethering with your phone
# Let your raspberry pi use the internet!

== Pen Testing ==

# Install your veeOP
# Add WiFi USB Dongle
# Use Kali linux
# Write scripts to pen test your wifi networks while your car is parked.
# Harden your networks against mobile attacks.

== Advanced Dash Cam ==

# Install your veeOP
# Add USB Video camera
# Add USB storage
# Make sweeter videos than the awesome russian dash cams!

== OBD-II / CANBUS ==

* Integrate your car's onboard diagnostics into an application which tracks your cars performance.

== HUDs ==

* Working on it!

== Touch-screen interfaces ==

* We'll get there!

== GPS Applications ==

* Track your every move.

== GSM Additions ==

* Use GSM + GPS to make your own "lo-jack" type device.

I²C API

2013-10-11T17:23:41Z

Doug: Created page with " The I²C API on the microcontroller is a rather simple little set of commands that rides on I²C. For more information about [http://en.wikipedia.org/wiki/I%C2%B2C I²C we di..."

The I²C API on the microcontroller is a rather simple little set of commands that rides on I²C. For more information about [http://en.wikipedia.org/wiki/I%C2%B2C I²C we direct you to Wikipedia].

In practice, this is also abstracted by the veeOP REST API, which resides on the Raspberry Pi. The REST API is much more verbose, and provides more flexibility in handling the day-to-day tasks with your veeOP. But, should you see an opportunity to extend it's communication -- it's a simple system. Don't let all the bits and bytes confuse you here, when it comes down to it it's this simple:

#Raspberry Pi says "Hi, microcontroller, I want you to do something."
##...And sends it 4 bytes to tell it to do so.
#Microcontroller says "Sure! I did what you want, and here's some info about it."
##...And it sends 4-bytes back to the Raspberry Pi.

The veeOP uses the Raspberry Pi as the I²C master, with the arduino-compatible being the slave, at address 4 (0x04) by default (this is configurable in the library.)

== Download the code! ==

If you're using one of the downloadable pre-customized distros, you can look in:

/home/pi/arduino-vop/src/

For the source code. But, if you really want to dig in -- [https://code.google.com/p/arduino-vop/ download the code from google code].

It's as simple as placing the vOP folder into your libraries folder in your Arduino's default install directory, to compile it. Check out the provided example sketch as it will guide you into extending the functionality. You can use the provided example sketch to keep the veeOP functionality intact, but! Use the microcontroller for other purposes, and it's extend it's functionality.

== How Commands are transmitted ==

Commands are sent to the veeOP arduino-compatible with a 4-byte tuple. It looks like so:

: <math>(C,P_1,P_2,C_e)</math>

Where each element is a single byte, representing:

: <math>
\begin{align}
C & = \text{Command} \\
P_1 & = \text{First Parameter} \\
P_2 & = \text{Second Parameter} \\
C_e & = \text{Command Ending (0x0A)} \\
\end{align}
</math>

 
* <math>C</math> (command) is any (known) value other than 10 (0x0A, in hex.) and originally assigned all higher 10.
* <math>P_1</math> & <math>P_2</math> are sometimes treated as individual integer values each, or together as a 16 bit integer, depending on context.
* <math>C_e</math> Command ending allows the microcontroller know when a command is incomplete, or too many bytes are sent.
 

Why's it end in 10? It's the "end of line" ASCII character, check it out [http://asciitable.com asciitable.com].

== How responses are received ==

When the microcontroller recieves the proper 4 bytes for the command, it responds in turn with a response of 4 bytes.

: <math>(E,C_r,R_1,R_2)</math>

Where each element is a single byte, representing:

: <math>
\begin{align}
E & = \text{Error Code} \\
C_r & = \text{Command return} \\
R_1 & = \text{First return byte} \\
R_2 & = \text{Second return byte} \\
\end{align}
</math>

 
* <math>E</math> errors of a value of 0 denotes an error-free response, any non-zero value is defined in a table below.
* <math>C_r</math> is a redundant byte that represents <math>C</math> from the sent command. This is used for error handling on the raspberry pi.
* <math>R_1</math> & <math>R_2</math> are the resulting responses from the command. Treated as two bytes, or a 16-bit unsigned integer depending on the context of the command.
 

== Commands ==

In this chart, we show each available command, and it's return type. The example commands and responses are given showing each 4-byte command and response, in decimal.

{| class="wikitable"
|-
! Command Description !! Value !! <math>P_1</math> !! <math>P_2</math> !! Returns !! Example Command (Decimal) !! Example Response (decimal) !! Example Description
|-
|Check Ignition State
| 11
| align="center" | -
| align="center" | -
| Boolean
| align="center" | <math>(11,0,0,10)</math>
| align="center" | <math>(0,11,0,1)</math>
| Response showing the ignition is on. An <math>R_2</math> value of 1 denotes the ignition is on, where a value of 0 denotes it being off.
|-
|Last time ignition changed (seconds ago)
| 12
| align="center" | -
| align="center" | -
| 16-bit Integer
| align="center" | <math>(12,0,0,10)</math>
| align="center" | <math>(0,12,1,2)</math>
| Responds showing us the ignition last changed it's state 258 seconds ago. See 16-bit integer note, below.
|-
|Last time ignition changed (minutes ago)
| 13
| align="center" | -
| align="center" | -
| 16-bit Integer
| align="center" | <math>(13,0,0,10)</math>
| align="center" | <math>(0,13,0,90)</math>
| Responds showing us the ignition last changed it's state 90 minutes ago
|-
|Pat the watchdog
| 15
| align="center" | -
| align="center" | -
| -
| align="center" | <math>(15,0,0,10)</math>
| align="center" | <math>(0,15,0,0)</math>
| Responds simply stating it pat the watchdog without an error.
|-
|Echo bytes sent
| 14
| align="center" | Byte
| align="center" | Byte
| 2 Bytes
| align="center" | <math>(14,1,2,10)</math>
| align="center" | <math>(0,14,1,2)</math>
| Simply echos the sent bytes back. Returns <math>P_1</math> as <math>R_1</math> and returns <math>P_2</math> as <math>R_2</math>. Mainly useful as
|}

=== 16-bit Integer Example ===

Using the "Last time ignition changed (seconds ago)" command example from above.

Note that <math>R_1</math> and <math>R_2</math> represent a 16 bit integer.In the response <math>(1,2)</math> could be represented as bytes in hex as <math>\text{(0x01,0x02)}</math>, which will convert as a little endian into a decimal value of <math>\text{0x102 hex = 258 dec}</math>

== Error Codes ==

{| class="wikitable"
|-
! <math>E</math> value !! Code Constant !! Description
|-
| align="center" | 1 || ERR_BUFFER_OVERFLOW || Too many bytes received before <math>C_e</math>
|-
| align="center" | 2 || ERR_COMMAND_UNKNOWN || Command is unknown.
|-
| align="center" | 3 || ERR_COMMAND_INCOMPLETE || Request for data from master received before <math>C_e</math> sent.
|}

Microcontroller And Electronics

2013-10-09T15:34:13Z

Doug: /* Re-programming the on-board Arduino Compatible */

== Re-programming the on-board Arduino Compatible ==

The veeOP has an on-board arduino compatible, allowing you to customize it to the fullest extent.

The tool included with the downloadable distros here is the [http://inotool.org/ InoTool, a command-line Arduino tool]. To get into the details, check out their [http://inotool.org/#installation installation guide], and their [http://inotool.org/quickstart quick-start guide]. But, we'll go over the details here, too.

In the distros provided here in the home directory for the "pi" user, you'll find a directory named 'arduino-vop' which already has an editable version of the code that's already on the microcontroller that you can use to get started!

[[Image:aon-jumper-web.png|thumb|225px|Location of the "always on" (A-ON) header/jumper on the veeOP. (Shown with jumper off)]]

=== Hardware Steps ===

One important step if you're going to re-program the microcontroller on the veeOP is to use a jumper on the "A-ON header" (short for "always on"). Because the veeOP controls power to the Raspberry Pi, when programming it -- you don't want the veeOP to turn off your Raspberry Pi. When a jumper is on this header, it makes it so that the Raspberry Pi is always in an on state. It's also imperative that you take the jumper off when you're ready to put the veeOP back in your vehicle, as it won't function the way it's intended! ...As you might imagine.

Another option for programming the on-board arduino compatible microcontroller is to use the FTDI header on the board. This allows you to use an FTDI cable (which is basically a USB-to-RS232 adapter) to reprogram the microcontroller. Allowing you to program the micro without using the Raspberry Pi. However, since this also supplies the board with power, it's important that you do not have a micro USB cable attached, too.

Your veeOP should come with jumpers provided. However, if you are to lose them, any standard jumper from a PC will also work. (Or you can wrap a wire around them, in a pinch.)

=== Installing the necessary tools ===

If you're not using a veeOP customized distro, you might wish to install the tools from scratch. The examples given here are from Raspbian, but, can be easily applied to most distros.

First install Arduino and the requirements for inotools

sudo apt-get install arduino
sudo apt-get install python-setuptools
sudo apt-get install picocom

Then install ino with easy_setup

sudo easy_install ino

Add the pi user to the tty group

sudo usermod -a -G tty pi

And make a symlink to the tty that inotool / arduino likes...

sudo ln -s /dev/ttyAMA0 /dev/ttyACM0

And make sure it's writable

sudo chmod o+w /dev/ttyAMA0

== Download the code! ==

: ''Main Article:'' [[Downloads]]

If you're using one of the downloadable pre-customized distros, you can look in:

/home/pi/arduino-vop/src/

For the source code. But, if you really want to dig in -- [https://code.google.com/p/arduino-vop/ download the code from google code].

It's as simple as placing the vOP folder into your libraries folder in your Arduino's default install directory, to compile it. Check out the provided example sketch as it will guide you into extending the functionality. You can use the provided example sketch to keep the veeOP functionality intact, but! Use the microcontroller for other purposes, and it's extend it's functionality.

== Using Arduino Shields with your veeOP ==

The veeOP is designed to be able to extend it using Arduino Shields. There are shields for all kinds of applications

* GPSr (global position system recievers)
* GSM (cell phone service)
* LCD Displays
* Wireless (like the ZigBee / XBee)
* And much, much more.

[[Image:VeeOP_v003.png|thumb|350px|The veeOP schematics as of v0.300]]

== The Schematics ==

An extensible platform isn't exactly that without knowing how to really dig deep into the electronics. You can simply use the board "like an attached Arduino-compatible" -- or you can really get in and hack it how you want.

Or! You can even build your own. We've included the schematic to show you that we really do care about the Open Source Hardware (OSHW) movement.

== Are you new to Arduino? ==

Don't sweat it! [http://arduino.cc/ The Arduino] is intended to be an approachable technology, and one that gives a new user a lot of power. And, you'll feel great interacting directly with microcontrollers. The best part is, you can use your veeOP to help you learn.

You can log onto the veeOP connected to your raspberry pi, but, you might want to [http://arduino.cc/en/Main/Software download the Arduino IDE] (integrated development environment) and get started on your workstation (your laptop or desktop computer). You can compile the veeOP code right there to do some initial testing and exploration.

Some resources you might be interested in:

* [http://arduino.cc/en/Guide/HomePage Getting Started With Arduino]
* [http://arduino.cc/en/Main/Software Arduino Software Download]
* [http://oreilly.com/arduino/ O'Reilly Arduino Development Landing Page]
* [http://shop.oreilly.com/product/9780596802486.do The Arduino Cookbook]

== The I²C API ==

: ''Main Article:'' [[I²C API]]

The I²C API on the microcontroller is a rather simple little set of commands that rides on I²C. For more information about [http://en.wikipedia.org/wiki/I%C2%B2C I²C we direct you to Wikipedia].

In practice, this is also abstracted by the veeOP REST API, which resides on the Raspberry Pi. The REST API is much more verbose, and provides more flexibility in handling the day-to-day tasks with your veeOP. But, should you see an opportunity to extend it's communication -- it's a simple system. Don't let all the bits and bytes confuse you here, when it comes down to it it's this simple:

#Raspberry Pi says "Hi, microcontroller, I want you to do something."
##...And sends it 4 bytes to tell it to do so.
#Microcontroller says "Sure! I did what you want, and here's some info about it."
##...And it sends 4-bytes back to the Raspberry Pi.

The veeOP uses the Raspberry Pi as the I²C master, with the arduino-compatible being the slave, at address 4 (0x04) by default (this is configurable in the library.)

== Advanced Resources ==

[[Image:dtr_on_logic.jpg|thumb|300px|Looking at the DTR and Serial RX/TX lines on a HP Logic Analyzer (from 1984!) on the ATMega while developing the veeOP]]

Other resources that were valuable as the interface between the veeOP board and Raspberry Pi for programming the onboard arduino-compatible:

* [http://openmicros.org/index.php/articles/94-ciseco-product-documentation/raspberry-pi/288-programming-an-arduino-from-your-raspberry-pi-with-ciseco-hardware Triggering microcontroller reset using Raspberry Pi's GPIO]
* [http://openmicros.org/index.php/articles/94-ciseco-product-documentation/raspberry-pi/283-setting-up-my-raspberry-pi Another approach to programming an arduino compatible using a Raspberry Pi]
* [http://www.deanmao.com/2012/08/12/fixing-the-dtr-pin/ Fixing the DTR Pin]
* [http://elinux.org/RPi_GPIO_Interface_Circuits#Level_Shifters Logic Level example schematics from eLinux]
* [http://elinux.org/RPi_Serial_Connection eLinux's Serial Connection article]
* [http://codeandlife.com/2012/07/29/arduino-and-raspberry-pi-serial-communication/ An article about connecting serial communications to the Arduino from the Raspberry Pi]

Main Page

2013-10-03T15:09:25Z

Doug:

The '''veeOP''' is the '''Raspberry Pi Vehicle Operating Platform'''.

It's an extensible open source hardware (and software) platform, that enables you to use your Raspberry Pi in your vehicle. It's core function is to allow you to smoothly power on, and off the Raspberry Pi by the state of your vehicle's ignition. This helps with headless (no display) implementations, and is also convenient for implementations with a display (or even a touch-screen). It has the capability to communicate a command to the Raspberry Pi to say "Hi, the ignition is off, please let the veeOP know when you'd like to power down". So that your implementation of a Raspberry Pi "carputer" can stay powered on when you need it to, and power it down when you don't -- say for example, if you're stopped at a gas station and need your ignition to be off, you don't have to reboot your Raspberry Pi

The veeOP is "application agnostic", that is, it gets you over the hurdle of the complexity of the power supply, and lets you get to the "good stuff" -- you know, like media center applications, GPS applications, or ''anything'' that you can imagine.

But! It doesn't end there. It's based on an Arduino-compatible microcontroller that you can reprogram. And it has a RESTful API that allows you to extend it's core functionality. This wiki will guide you through the steps that you need to take full control of your veeOP.

== Categories ==
{| width=100%
| valign="top" |
{| cellspacing=5 cellpadding=5 border=0 width=100%
|width=48|{{Click || image=Nuvola_apps_kdict.png | link=User_Manual:Index | width=48px | height=48px }}
|'''[[User_Manual:Index|User Manual]]''' The veeOP User Manual
|width=48|{{Click || image=Nuvola_apps_ktip.png | link=Application Ideas | width=48px | height=48px }}
|'''[[Application Ideas]]''' Ideas of what you can do with your Raspberry Pi carputer.
|-
|width=48|{{Click || image=Nuvola_apps_khelpcenter.png | link=Frequently Asked Questions | width=48px | height=48px }}
|'''[[Frequently Asked Questions]]''' A collection of the questions and answers
|width=48|{{Click || image=Nuvola_apps_download_manager.png | link=Downloads | width=48px | height=48px }}
|'''[[Downloads]]''' Download distros pre-loaded with all the veeOP software.
|-
|colspan=4|<hr>
|-
|width=48|{{Click || image=Nuvola_apps_khexedit.png | link=REST API | width=48px | height=48px }}
|'''[[REST API]]''' The ins-and-outs of the RESTful API
|width=48|{{Click || image=Nuvola_apps_kcmprocessor.png | link=Microcontroller And Electronics | width=48px | height=48px }}
|'''[[Microcontroller And Electronics]]''' Wrangle in the power of the on-board Arduino-compatible microprocessor, and use it for your applications.
|-
|width=48|{{Click || image=Icon_tools.png | link=Vehicle Installation | width=48px | height=48px }}
|'''[[Vehicle Installation]]''' Details on how to install the veeOP (and your Pi!) in your vehicle
|width=48|{{Click || image=Nuvola_apps_kpackage.png | link=I²C API | width=48px | height=48px }}
|'''[[I²C API]]''' Get in depth with the microcontroller code, and it's I²C API
|-
|width=48|{{Click || image=Nuvola_apps_edu_science.png | link=Laboratory B | width=48px | height=48px }}
|'''[[Laboratory B]]''' Come learn in person about veeOP at Laboratory B, the hackerspace in Burlington, Vermont USA
|}
| width=220 valign=top | {{Template:Featured_Articles}}
|}

== In progress notes... ==

[http://commons.wikimedia.org/wiki/Category:Nuvola_icons Sweet Icons from wikimedia]

'''MediaWiki has been successfully installed.'''

Consult the [//meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.