Microcontroller And Electronics - Revision history

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

2013-10-24T03:39:17Z

‎Re-programming the on-board Arduino Compatible

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

2013-10-12T15:55:40Z

‎Re-programming the on-board Arduino Compatible

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

2013-10-12T15:47:47Z

‎Re-programming the on-board Arduino Compatible

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

2013-10-12T15:45:36Z

‎Re-programming the on-board Arduino Compatible

Doug at 15:45, 12 October 2013

2013-10-12T15:45:17Z

Doug at 17:58, 11 October 2013

2013-10-11T17:58:09Z

Doug at 17:45, 11 October 2013

2013-10-11T17:45:14Z

Doug: move i2c api to new article.

2013-10-11T17:26:00Z

move i2c api to new article.

Doug at 17:19, 11 October 2013

2013-10-11T17:19:42Z

Doug at 17:19, 11 October 2013

2013-10-11T17:19:01Z

@@ Line 19: / Line 19: @@
 === 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 PiDora (the Fedora distro for the pi), but, can be easily applied to most distros.
+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.
-For example, where I say "yum install package_name" under a Debian-based distro you can use "apt-get install package_name".
+First install Arduino and the requirements for inotools
 == Download the code! ==

@@ Line 7: / Line 7: @@
 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) jumper on the veeOP. (Shown with jumper off)]]
+[[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 jumper" (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. This jumper makes it so that the Raspberry Pi is always in an on state when the jumper is in place. 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.
+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.

← Older revision		Revision as of 15:47, 12 October 2013
Line 14:		Line 14:

	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.		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 ===		=== Installing the necessary tools ===

@@ Line 7: / Line 7: @@
 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|300px|Location of the "always on" (A-ON) jumper on the veeOP. (Shown with jumper off)]]
+[[Image:aon-jumper-web.png|thumb|225px|Location of the "always on" (A-ON) jumper on the veeOP. (Shown with jumper off)]]
 === Hardware Steps ===

← Older revision		Revision as of 15:45, 12 October 2013
Line 7:		Line 7:
	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!		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\|300px\|Location of the "always on" (A-ON) 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 jumper" (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. This jumper makes it so that the Raspberry Pi is always in an on state when the jumper is in place. 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.

	=== Installing the necessary tools ===		=== Installing the necessary tools ===

@@ Line 13: / Line 13: @@
 For example, where I say "yum install package_name" under a Debian-based distro you can use "apt-get install package_name".
@@ Line 61: / Line 73: @@
 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 ==

@@ Line 24: / Line 24: @@
 * Wireless (like the ZigBee / XBee)
 * And much, much more.
 == Are you new to Arduino? ==

← Older revision		Revision as of 17:26, 11 October 2013
Line 62:		Line 62:

	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.		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>~~
−
−	~~<BR />~~
−	* <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.
−	~~<BR />~~
−
−	~~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>~~
−
−	~~<BR />~~
−	* <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.
−	~~<BR />~~
−
−	~~=== 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.~~
−	\|}

	== Advanced Resources ==		== Advanced Resources ==

@@ Line 135: / Line 135: @@
 | 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. Note that <math>R_1</math> and <math>R_2</math> represent a 16 bit integer.<BR> 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>
+| 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)
@@ Line 162: / Line 162: @@
 | 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>
+| 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
 |}
 === Error Codes ===

← Older revision		Revision as of 17:19, 11 October 2013
Line 39:		Line 39:

	== The I²C API ==		== 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].		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].