Digistump Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
======Oak: serial communication through an Arduino======

The Oak uses a 3.3V serial interface on pins 3 (RX) and 4 (TX). This interface is useful for communicating wth serial-enabled peripheral devices, transmitting debug messages and program data, receiving messages, and flashing firmware.  This last use case is an essential component of the [[A serial interface|Oak factory restore procedure]].  

One can communicate directly with the Oak through a 3.3V USB/UART adapter (ex: [[http://www.amazon.com/Module-Serial-Converter-Adapter-CH340G/dp/B00W74BTK2|1]], [[https://www.sparkfun.com/products/13263|2]]) if available, or through a 5V UART with special considerations for level conversion and/or current limiting.  

This article describes an alternative method which uses an Arduino as a USB serial converter.  This method is particularly convenient for those of us who don't have a 3.3V USB UART on-hand but do happen to have a spare Arduino.

{{ :oak:tutorials:img_20160316_185542.jpg?400 |}}

===== Components used =====

^ Part       ^ Quantity          ^
| Oak with soldered headers |1|
| Arduino| 1|
| Breadboard| 1|
| Jumper wires| 5-6|
| 1 kOhm resistor* | 1|
| 2 kOhm resistor* | 1|

** * Note:** The resistor values above are not critical. \\ 
See [[http://digistump.com/wiki/oak/tutorials/serial_through_arduino#voltage_divider_resistor_selection|Voltage Divider Resistor Selection]] \\ 
and [[http://digistump.com/wiki/oak/tutorials/serial_through_arduino#example_voltage_divider_resistor_combinations|example resistor combinations]] below.
\\ 
----

=== Jump to: ===
 * [[http://digistump.com/wiki/oak/tutorials/serial_through_arduino#procedure_for_connecting_oak_to_arduino_with_voltage_divider|Procedure for building the circuit]] (voltage divider method)
\\ 
----
===== A Word about Counterintuitive Arduino UART Connections =====

Normally, we connect one device's Tx pin to another's Rx pin, and vice versa.  For example, if we were to connect the Oak to a computer, either through a native serial interface or through a USB-TTL dongle, the signal paths would be as follows:
<code>
Computer          Oak
--------          ---
UART TX --------> RX
UART RX <-------- TX

or 

Computer         USB-TTL Converter           Oak
--------         -----------------           ---
USB Tx --------> USB Rx -> UART Tx  --------> Rx
USB Rx <-------- USB Tx <- UART Rx  <-------- Tx
</code>

However, the Arduino pin labeling does not follow this convention.  

We will be operating our Arduino in pass-through mode.  We force this mode by shorting the reset pin to ground, which essentially turns off the ATmega main processor and allows direct access to the usb-serial interface via the Arduino's "Tx" and "Rx" pins.  A word of caution: in the mode in which we will operate our Arduino, the pins labeled "Tx" and "Rx" act opposite of their labels:  the "Rx" pin transmits and the "Tx" pin recieves.

Although counterintuitive, these seemingly backward labels are not an error.  The reason for this convention has to do with the Arduino architecture.  The Arduino features an internal usb-serial interface which dual purposes as a TTL UART when a user sketch is running, and acts as a pass-through when tri-stated, which is how we plan to use it.  The Arduino pin labeled "Rx" mirrors signal received //from the computer// over USB, while the pin labeled "Tx" mirrors signal to be transmitted //to the computer// over USB.  Wierd, right?

<code>
Computer         Arduino                       Oak
--------         --------------------           ---
USB Tx --------> USB Rx -> PIN0 "Rx"* --------> Rx
USB Rx <-------- USB Tx <- PIN1 "Tx"* <-------- Tx

     *NOTE: The Arduino "Rx" pin mirrors signal received over USB, 
      while the "Tx" pin stages signal to be transmitted over USB.
      
    **NOTE 2: this is NOT a wiring diagram.  Connecting the Oak Rx 
      pin directly to the Arduino "Rx" pin is not advised.
</code>
\\ 
----


===== Schemes for connecting the Oak to an Arduino =====

Four methods for connecting an Arduino UART to an Oak are described here:
  - Using a logic level converter to cut Oak Rx input voltage to 3.3V
  - Using a voltage divider resistor network to cut Oak Rx input voltage to 3.3V
  - Using a current limiter resistor
  - Direct connection ([[https://digistump.com/wiki/oak/tutorials/serial_through_arduino#warning_regarding_direct_connection_to_5v_uart|not recommended]])

==== Warning regarding direct connection to 5V UART ====
Several users ([[http://digistump.com/board/index.php/topic,2036.msg9266.html#msg9266|1]], [[https://github.com/digistump/OakCore/issues/56#issuecomment-197618541|2]]) have reported success wiring an Oak's Tx/Rx pins directly to an Arduino's 5V UART.  The   [[https://www.adafruit.com/images/product-files/2471/0A-ESP8266__Datasheet__EN_v4.3.pdf|ESP8266 data sheet]] describes over-voltage protection on all GPIO pins (pg 17+), suggesting the Oak should be able to safely read 5V TTL signal directly.  However, it is not well known whether operating in this way degrades the life of the ESP8266.  Inserting a resistor (300+ Ohm, typ. 1K) between the Arduino's 5V transmit pin and the Oak's Rx pin will help to limit current into the Oak, although the signal level received by the ESP8266 will still be 5V at the Oak Rx pin, and the same caution regarding the longevity of your Oak still applies.  If you choose to connect your Oak to a 5V serial signal, either directly from an external 5V UART or through a current limiting resistor, do so at your own risk.

==== Recommended solutions ====
The recommended solution is to **bring the external UART's 5V Tx line down to 3.3V for the Oak**, using either a [[https://www.sparkfun.com/products/12009|logic level converter]] if available, or a voltage divider circuit.  This recommendation applies whether the external UART is an Arduino or any other 5V UART.  The rest of this tutorial focuses on the voltage divider option since it uses common components which many Oak users have on-hand.
==== Option 1:  Using a bi-directional logic level converter (if available) ====
  * Also see: [[https://learn.sparkfun.com/tutorials/bi-directional-logic-level-converter-hookup-guide|Sparkfun BDLC hookup guide]]
<code>
  Arduino 5V  ----------- HV  Level Converter LV  ---------- Oak 3.3V
  Arduino "Tx"* --------- HV1 Level Converter LV1 ---------- Oak Tx
  Arduino "Rx"* --------- HV2 Level Converter LV2 ---------- Oak Rx
  Arduino Gnd ----------- Gnd Level Converter Gnd ---------- Oak Gnd
  
     *NOTE: The Arduino "Rx" pin mirrors signal received over USB, 
      while the "Tx" pin stages signal to be transmitted over USB.
</code>

==== Option 2:  Voltage-divided input line ====
  * See [[http://digistump.com/wiki/oak/tutorials/serial_through_arduino#voltage_divider_resistor_selection|Voltage Divider Resistor Selection]] for guidance regarding selection of resistors R1 and R2
<code>
  Arduino "Tx"* ------------ Oak Tx
  Arduino "Rx"* ---R1--+---- Oak Rx
                       |                  
                       R2                 
                       |
    Arduino Gnd -------+---- Oak Gnd

     *NOTE: The Arduino "Rx" pin mirrors signal received over USB, 
      while the "Tx" pin stages signal to be transmitted over USB.
</code>
==== Your mileage may vary:  Current-limited 5V to Oak ====
  * Limits current into Oak Rx pin, should be safer than direct connection.
  * Leaves input signal at 5V.  Impact to ESP8266 life is not well documented.
<code>
  Arduino "Tx"* ---------- Oak Tx
  Arduino "Rx"* ----1K---- Oak Rx      <-- 5V input - do so at your own risk
  Arduino Gnd   ---------- Oak Gnd
  
     *NOTE: The Arduino "Rx" pin mirrors signal received over USB, 
      while the "Tx" pin stages signal to be transmitted over USB.
</code>
==== Not recommended:  Direct connection ====
  * Reported to work by multiple users.
  * Leaves input signal at 5V.  Impact to ESP8266 life is not well documented.
<code>
  Arduino "Tx"* ---------- Oak Tx
  Arduino "Tx"* ---------- Oak Rx      <-- 5V input - do so at your own risk
  Arduino Gnd   ---------- Oak Gnd
  
     *NOTE: The Arduino "Rx" pin mirrors signal received over USB, 
      while the "Tx" pin stages signal to be transmitted over USB.
</code>

\\ 
----




===== Voltage Divider Resistor Selection =====

Since each maker's resistor collection is different, this article describes design considerations which allow flexibility in resistor selection, rather than specifying one set of resistance values.  Read on for a brief explanation for selecting resistors, or skip to  [[https://digistump.com/wiki/oak/tutorials/serial_through_arduino#example_voltage_divider_resistor_combinations|example resistor combinations]].

The resistors are needed to create a "voltage divider." There are many explanations and tutorials around this topic, which you are encouraged to take a look at, such as the one found on [[https://learn.sparkfun.com/tutorials/voltage-dividers/all?print=1|SparkFun]]. The short summary for the purposes of this tutorial is that the input voltage can be dropped to a desired output like so:

<code>
    Vin (input voltage) (5V TTL from Arduino transmit line)
     |
     R1
     |
     +-----o  Vrx (3.3V TTL to Oak Rx)
     |
     R2
     |
    Gnd
</code>

If the resistances of R1 and R2 are small relative to the input impedance on the Oak's ESP8266 Rx pin (megaohm range), the voltage at the junction will be similar to that of an ideal voltage divider with no load attached to the junction:
<code>
Vrx = Vin * R2/(R1+R2)
  or, solving for R2:
R2 = R1 * Vrx/(Vin-Vrx)
</code>

In our case, we need Vrx to be near 3.3V, while Vin will be 5V from the Arduino's Tx pin.  We can combine this information with the voltage divider equation above to solve for a relationship between the resistance values that we'll select:  R2 = 1.94 * R1.  However, the ESP8266 will interpret anything above 2.5V as a high signal, so we have some wiggle room on the resistor relationship.  Since we're trying to keep this voltage near the design point of 3.3V (in theory, ESP8266 can accept up to 6V, but potential degradation is not well documented), we'll limit Vrx_max to 3.6V:
<code>
  Vrx_min 2.5V   -->   R2 >= R1
  Vrx_max 3.6V   -->   R2 <= R1*2.5   (staying near 3.3V design point; in theory can be higher)
  
  R1 <= R2 <= 2.5*R1
</code> 
Neat!  This gives us a range of resistance values to work with.  For example, if we dig into our bucket of resistors and pull out a 1K and call this R1, then R2 can be anything between 1K and 2.5K.

The relationship between R1 and R2 is not enough information to select a pair of resistors.  Also keep in mind that R1+R2 needs to be low relative the input impedance of the ESP8266 Rx pin (MOhm range).  If the total impedance is too low (<250 Ohm), then you'll risk damaging the Arduino.  Typical values for R1 and R2 are in the 1K-50K range.

==== Example Voltage Divider Resistor Combinations ====
^ R1  ^ R2 Range  ^
| 500 | 500 - 1.2K |
| 1K  | 1K - 2.5K |
| 2K  | 2K - 5K   |
| 4K  | 4K - 10K  |
| 8K  | 8K - 20K  |
| 16K | 16K - 40K |

            

\\ 
----

===== Building the Voltage Divider Circuit =====

This tutorial focuses on the voltage division method for connecting the Oak to an Arduino UART.  To build this circuit, you'll need to select two resistors per the guidance provided [[http://digistump.com/wiki/oak/tutorials/serial_through_arduino#voltage_divider_resistor_selection|above]].  

| FIXME: Redraw the Fritzing diagram.  The Arduino "Rx" pin should connect to the TOP of the voltage divider.  The Oak Rx pin should connect to the voltage divider junction.  The Arduino Tx pin should connect directly to the Oak Tx pin.  Add jumper between Arduino Reset and ground. |
\\ 
==== Procedure for Connecting Oak to Arduino with Voltage Divider ====

  * Jumper the Arduino RESET pin to ground.
  * Connect the Arduino ground line to one row in the breadboard.
  * Connect the Oak ground line to the Arduino ground line via the breadboard.
  * Insert the larger resistor into the breadboard, connecting one lead to ground and inserting the other lead into an unused row. 
  * Insert the smaller resistor into the breadboard in series with the larger resistor
    * Connect one lead of the smaller resistor to the open lead from the larger resistor.
      * This connection point will be called the "junction".
    * Insert the other lead into an open row in the breadboard.
  * Connect the Arduino "RX" pin to the smaller resistor, on the side that is not connected to the junction.
  * Connect the Oak Rx pin to the junction.
  * Connect the Oak TX pin directly to the Arduino Tx pin.
  * If you are using this procedure to restore the Oak, connect pin 2 of the Oak to ground
  * If you are going to power the Oak with the Arduino, connect the 3.3V pin on the Arduino to Vin on the Oak. Otherwise, insert a micro USB cable into the Oak, leaving the other end unplugged
  * Once these connections are complete, both the Arduino and Oak may be powered on


=== Example ===
This user's setup uses 220 ohm and 1k ohm resistors for the voltage divider and jumps pin 2 to ground for restoring the Oak:

[[http://digistump.com/wiki/_media/oak/tutorials/img_20160316_185542.jpg|{{:oak:tutorials:img_20160316_185542.jpg?400}}]]

\\ 
----

===== Example Sketch for Oak Serial Communication =====

Using the circuit above (with pin 2 //not// grounded) with an added potentiometer, we can read a value and send it to the computer via serial communication. Here is the modified circuit:

<code>
// define a variable to hold the value
int pot = 0;

void setup()
{

  // start the serial interface
  Serial.begin(9600);

}

void loop() {

  // read the value of pin A0, store it in the variable, "pot"
  pot = analogRead(A0);

  // print that value to the serial interface
  Serial.println(pot);

  // wait 500 milliseconds
  // this just slows down the rate of data being sent
  // so that it's easier to see in the serial monitor
  delay(500);
  
  // since this is within loop(), the program will
  // return to the top and begin again by reading pin A0

}
</code>


The code turns serial on with ''Serial.begin()'' in the ''setup()'' section. Next, it begins to run the ''loop()'' section again and again, reading the value of pin ''A0'' (the Oak's only analog pin), storing it in the variable ''pot''. Lastly it is sent over serial with the ''Serial.print()'' command to the computer.

Flash the sketch, and then open the Arduino IDE. Set the correct port (''Tools -> Port'') and then open the serial monitor (''Tools -> Serial Monitor'') to begin listening. Make sure the baud rate (lower right hand of the serial monitor) is set to 9600. You should see a string of numbers that changes when you rotate the potentiometer:

[[http://digistump.com/wiki/_media/oak/tutorials/2016-03-17_225049.png|{{:oak:tutorials:2016-03-17_225049.png?400}}]]

===== Conclusion =====

You now know how to connect to the Oak via serial through an Arduino if you don't have a USB UART device. If you ever need to restore your Oak, you are now able to do so by following the instructions [[https://github.com/digistump/OakRestore|here]], and you now know how to read the values from an input such as a potentiometer or sensor. Do you have other sensors could you try to read? Using microcontrollers often relies on a condition, followed by an action. For example, "if it gets dark outside, turn on my outside lights." If you were using a [[oak:tutorials:photocell|photocell]] to read the brightness outside, what value translates to "dark enough to turn the lights on"? Now you can connect your sensor and read the value from the photocell in real time so you know what to use.
Digistump Wiki

User Tools

Site Tools

Page Tools
