ca Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
FIXME //Not enough cats.//

====== Some Assembly Required ======
Comp Arch Fall 2013 final project

[[http://www.horizonhobby.com/products/venom-creeper-rock-crawler-kit-1-10-green-electric-VNR8300GR#t2|{{ :projects:assembly_required.png?675|Is Assembly Required: Yes}}]]

\\
\\

{{ :projects:magpie.jpg?700 |}}

Team: Charles Goddard (2015), Victoria Coleman (2015), Eric Tappan (2015)

===== What We Did =====
We created an autonomous robot that explores the world in linear trajectories while avoiding obstacle using IR range-finding. 

The robot is a Venom RC car altered to be controlled by an Arduino Uno programmed in AVR Assembly (a very low-level programming language specific to the type of hardware used). The Arduino communicates to the hardware system (both the sensors and motors) using PWM (Pulse Width Modulation), a protocol often used to control servos and in Remote Control. To sense the world, there are two IR sensors mounted on the front of the robot to determine the proximity of obstacles in its path and determine the best direction to turn to avoid them.

When there are no obstacles around the robot, it goes full-speed directly forwards. When it senses an object, it slows down and turns away. If the object gets too close, the robot enters an "OHMYGOODNESSIMGOINGTODIE" panic mode, stops, backs away from the object, and continues on its merry-way. 


==== Why We Did It ====
We chose to do our project mostly robots are awesome, and we wanted a derpy robot to play with. While we'd worked with MIPS assembly in class, working with an Arduino pushed us to get experience in the very different AVR Assembly. Working with a robot was an excellent way to experience working with hardware on a very low-level.
----
===== How We Did It =====
DELETEME //"This portion can assume an audience that has taken Computer Architecture, but don’t get burdened oby buzzwords. A sure sign of a bad engineer is over reliance on acronyms."//


==== Code Description ====
<code>
print "Hello world"
run robit --wallAvoid=True --becomeSkynet=False
</code>

=== PWM ===

The steering servo and electronic speed control both work off of standard 50 Hz Remote Control PWM signals. The pulse ranges from 1 ms to 2 ms, with ~1.5 ms being the neutral position.  For servos with larger ranges, you might see pulses between 0.5 and 2.5 ms (neutral will still be around 1.5 ms).

From the perspective of the car: straight forward is pulse-width 1472 microseconds, full right (~45 degrees) is pulse-width 956 us, full left (~45 degrees) is pulse-width 1884 us. Throttle is more straightforward with a 2 ms pulse signalling full throttle forward, 1.5 ms signalling neutral (or braking, depending on settings), and 1 ms signalling full reverse.

While the ATMega328 has built-in PWM support, it only supports fairly high frequencies. Ones much, much faster than the 50 Hz our car is expecting. To implement slow PWM we need to use some features of the AVR's timer/counter system. For a positive PWM we hold a signal high for one count (the pulse), then hold it low for the remainder of the 20 ms period before starting over.

== AVR Timers ==
The Atmega 328p on our Arduino has 3 internal timers (0, 1, and 2). Timers 0 and 2 are 8-bit timers, Timer 1 is a 16-bit timer. Settings are controlled by writing to the Timer Counter Control Registers (TCCRx, x=0,1, or 2).

Frequency is controlled partly via a prescaler, an integer which divides down the maximum frequency (16 MHz)--so the minimum non-zero prescaler of 8 makes the timer run at 2MHz, while a prescaler of 64 reduces the timer to 256KHz.

Timer 1 is a 16-bit timer with the option to run in compare mode, allowing us to trigger events much lower frequencies. This is useful for working with 50Hz RC PWM. In compare mode, the AVR will compare the number of timer counts to the value loaded in the Output Compare Register (OCR) and perform various operations when they match. This can generate square waves, control PWM, or generate interrupts. TCCR1A and TCCR1B is outlined below but the behavior is analogous for Timers 0 and 2. Bits which are not described were not used in this project but are described in the resources linked at the end of this page.

|TCCR1A:  |||||||||
|Bit  |7  |6  |5  |4  |3  |2  |1  |0  |
|Name  |COM1A1((Timer 1 Channel A config 1))  |COM1A0((Timer 1 Channel A config 0))  |COM1B1((Timer 1 Channel B config 1))  |COM1B0((Timer 1 Channel B config 0))  |FOC1A((Force Output compare for Compare Unit A))  |FOC1B((Force Output compare for Compare Unit B))  |WGM11((Waveform Generation Mode bit 1 (Timer 1)))  |WGM10((Waveform Generation Mode bit 0 (Timer 1)))  |
|Initial value  |0  |0  |0  |0  |0  |0  |0  |0  |

|TCCR1B:  |||||||||
|Bit  |7  |6  |5  |4  |3  |2  |1  |0  |
|Name  |ICNC1((Input Capture Noise Canceler))  |ICES1((Input Capture Edge Select))  |--  |WGM13((Waveform Generation Mode bit 3 (Timer 1)))  |WGM12((Waveform Generation Mode bit 2 (Timer 1)))  |CS12((Clock Select bit 2 (Timer 1)))  |CS11((Clock Select bit 1 (Timer 1)))  |CS10((Clock Select bit 0 (Timer 1)))  |
|Initial value  |0  |0  |0  |0  |0  |0  |0  |0  |

|COM1xy effects:  |||
|COM1x1  |COM1x0  |Description  |
|0  |0  |Normal Port Operation (The timer doesn't change the voltage on the i/o pin)  |
|0  |1  |Toggles OC1x((varies between ATmega chips)) on match  |
|1  |0  |Clears OC1x((varies between ATmega chips)) on match--set level Low (GND)  |
|1  |1  |Sets OC1x((varies between ATmega chips)) on match--set level High (VCC)  |

|CSxy effects:  ||||
|CSx2  |CSx1  |CSx0  |Effect  |
|0  |0  |0  |Timer stopped.  |
|0  |0  |1  |Clock = normal CPU frequency (FCPU)  |
|0  |1  |0  |Clk = FCPU/8  |
|0  |1  |1  |Clk = FCPU/64  |
|1  |0  |0  |Clk = FCPU/256  |
|1  |0  |1  |Clk = FCPU/1024  |
|1  |1  |0  |External Clock source on pin T0. Clock on falling edge.  |
|1  |1  |0  |External Clock source on pin T0. Clock on rising edge.  |

The TCNT1 port holds the current value of Timer Counter 1, divided into two 8-bit ports TCNT1H (holding the high byte) and TCNT1L (holding the low byte). This is compared to the 16-bit value stored in the Output Compare Registers (OCR1A and OCR1B for timer 1), OCR1xH and OCR1xL. WGMxy determines the effect on match. Options vary between processors, but for our purposes we only care about Clear Time on Compare (CTC) which will reset the timer to zero on a match.

|CTC:  ||||
|WGM13  |WGM12  |WGM11  |WGM10  |
|0  |1  |0  |0  |

The Timer Counter Interrupt Mask (TIMSK) is useful for more complicated timed operations, but all we need it for is to disable interrupts. This is done by clearing the register (filling it with 0s).

=== Sensor Processing ===

To decide how to react to the world determined to prevent the little robot from finding true freedom, the code samples from two analog input pins that are the signal wires to two IR sensors. The sensors are spaced apart and mounted on the front of the robot. In this way, the robot can determine how far away obstacles are, and determine how to turn from the side further way for more intelligent decision making.

Unfortunately, but not surprisingly, the sensors are very noisy fellows and require a lot of averaging to get any resemblance of smooth behavior. The documentation above specifically warns against adding a capacitor between the signal and ground or VCC, so an RC low-pass filter is inadvisable. We could get around that by filtering in another way, but this is a CompArch project, so we will do this in software! Arg! Therefore, we uses a simple rolling average of the last sixteen points. We discarded the use of an exponential rolling average due to the problems of floating point multiplication (sadness). Since the CPU is running many thousands of times faster than the sensor is providing new data (about 40ms), we make sure to only average distinct values. 

Taking an average of several values is obnoxious in AVR assembly, as eight bits is not enough for the sum of even two sensor values. We stored a 16 bit sum in two 8-bit registers and carefully took the carry into account while adding. Dividing before adding could allow us to work entirely within 8 bits, but would destroy precision.  

Based on the values from the sensors, we have three modes:

1. WHEEEEEEEEEEEEEEE! \\
2. Hmmmmm, a wall. I should probably avoid that. \\
3. OHMYGOODNESSAWALL. Panic! Beep!Beep!Beep! Honk.\\

In the "WHEEEEEEEEEE!" mode, the sensors are reading values below about 40 (meaning nothing is within about 45 cm), and the robot goes full forward in a strait trajectory. When the car gets to an obstacle less than 45 cm away, it goes into "Hmmmmm, a wall. I should probably avoid that," where the car turns towards the higher of the two values (towards the direction with the further away obstacle). If either of the values drop below about 10, then an obstacle is less than 700mm away, and the robot enters "OHMYGOODNESSAWALL. Panic! Beep!Beep!Beep! Honk." mode. In this mode, the robot turns towards the closer side of the obstacle and backs away until the robot is far enough away to successfully go to mode 2 without immediately losing its shit again. Unfortunately, we did not fully implement the third mode. Instead the car backs up just enough to lose its shit again. It does, however, eventually make its way out of the panic mode through this oscillation.
==== Code ====

We started our work with Assembly by simulating basic code in the Emulare AVR emulator. Once we were confident in our toolset we moved on to almost exclusively running code on the Arduino. We used the WinAVR toolset to build our code.

The basic architecture of our code is simple: we have a main loop that runs forever, reading samples from the ADC, averaging them, and then acting on the average. The snippet below shows the essence of our code, with some details removed.
 
<code>
main:
    call pwm_init
    call adc_enable

    ; ... (More initialization) ...

    .loop:
    ldi R24, 1       ; R24 = adc_read channel
    call adc_read    ; R24 = adc_read voltage read
    mov R25, R24
    ldi R24, 0       ; R24 = adc_read channel
    call adc_read    ; R24 = adc_read voltage read


    call add_sample
    call get_average ; R24 = adc rolling average for A0
                     ; R25 = adc rolling average for A1

    call evaluate
    call choose_steer_angle
    call choose_speed

    rjmp .loop
</code>

Our current build is comprised of two files, robit.S and data.S. These contain our actual logic and definitions of data locations in memory, respectively.
==== Gotchas ====

=== Register weirdness ===
[[http://www.avr-asm-tutorial.net/avr_en/beginner/REGISTER.html|Not all registers are created equal.]] For whatever reason **Registers R0 through R15 cannot load immediate values**. Only the Registers R16 through R31 can be set to an immediate value through the LDI command. The following commands are restricted to Registers R16 and above:
  ***ANDI Rx,K**: Bit-And of register Rx with a constant value K
  ***CBR Rx,M**: Clear all bits in register Rx that are set to one within the constant mask value M
  ***CPI Rx,K**: Compare the content of the register Rx with a constant value K
  ***SBCI Rx,K**: Subtract the constant K and the current value of the carry flag from the content of register Rx and store the result in register Rx
  ***SBR Rx,M**: Set all bits in register Rx to one, that are one in the constant mask M
  ***SER Rx** : Set all bits in register Rx to one (equal to LDI Rx,255)
  ***SUBI Rx,K**: Subtract the constant K from the content of register Rx and store the result in register Rx.

=== Analog Read ===
AVR's analog to digital converter is pretty weird.

Also, make sure your documentation holds true for your particular chip. We ran into some minor trouble because we trusted a table which implied that AVR chips universally have a 2.56V internal voltage for use with AREF. This is a lie. It is also sad.

=== Sharp IR is full of liars ===
We found many documents alleging to have graphs comparing Sharp IR voltage readings to real distances. These were false. We had much better luck, given our application, reading values via an Arduino script and configuring our regimes from there.

=== PWM for RC Servos ===
Apparently the only rule about RC servos is you don't talk about RC servos. Luckily there isn't a lot of variability in the PWM format. Generally, PWM for any RC servo or motor controller is going to want a 50 Hz signal (so 20 ms wide) with pulses between 1 ms and 2 ms long. 1 ms is the lowest angle or full reverse, 1.5 ms is halfway between the extremes or neutral, and 2 ms is greatest angle or full forward.

=== Enabling Correct Motor Controller Modes ===
Venom does not document very well at all. [[http://www.competitionx.com/pdf/esc/venom-pro-brushless-esc-manual.pdf|This]] is not the electronic speed control (ESC) for our car. The programming is at least similar enough to let our car go backwards. If it is not in the correct mode, the car will only be able to go forwards. How can you go two steps forwards without at least one back? You can't.
==== Hardware Implementation ====
{{http://cdn.instructables.com/FTX/AGWD/H05NT69Z/FTXAGWDH05NT69Z.LARGE.jpg?200 }}
Our robot is a Frankenstein of several components: an RC car chassis, an Arduino Uno, and two IR range-finder sensors.

The chassis we used as a [[http://www.horizonhobby.com/products/venom-creeper-rock-crawler-kit-1-10-green-electric-VNR8300GR#t1|Venom Creeper Rock Crawler]]. It was originally set-up to be controlled by RC, but we simply disconnected the motor controller and steering servo from the receiver. By wiring it to our Arduino we could mimic the PWM signal and run the car autonomously. We used an [[http://arduino.cc/en/Main/ArduinoBoardUno|Arduino Uno]] with its [[http://www.atmel.com/Images/doc8161.pdf|AtMega328 microcontroller]]. 90% of the information on the Arduino board is irrelevant if you're just using it as a platform for the AtMega but the schematics are there. The most significant detail is the connection between the raw AtMega pins and the I/O pins of the Arduino.

To sense the world around it to detect obstacles, we mounted two [[http://zuff.info/SharpGP2D12_E.html|Sharp GP2D12 IR range-finding sensors]] to the front of the robot. Some important characteristics are that it has a 40ms update period, so we need to do our averaging only with new values, not when we query it at a the high-rate we do. Also, the analog voltage is inversely proportional (in a non-linear fashion) to the distance values. It has the following alleged range and mapping: max 2.45V = 10cm and min 0.45V = 80cm with an error of 200mV. In practice, it was necessary to check values manually via an Arduino script.

{{ :projects:img_3395.jpg?400|}}


Mounted IR range-finding sensors using the sophisticated wonders of tape and cardboard. 

We used an [[http://arduino.cc/en/Main/ArduinoBoardUno|Arduino Uno]] with its [[http://www.atmel.com/Images/doc8161.pdf|AtMega328 microcontroller]]. 90% of the information on the Arduino board is irrelevant if you're just using it as a platform for the AtMega but the schematics are there. The most significant detail is the connection between the raw AtMega pins and the I/O pins of the Arduino.
|[[http://arduino.cc/en/uploads/Main/Arduino_Uno_Rev3-schematic.pdf|{{:projects:atmega_arduino.png?200|AtMega328 pins on the Arduino Uno.}}]]|
|Pin layout for the Arduino Uno. Similar schematics\\ are available for other boards at [[http://www.arduino.cc|the Arduino website]].\\ Note the distribution of Ports B, C, and D.|

The [[http://arduino.cc/en/uploads/Main/Arduino_Uno_Rev3-schematic.pdf| Arduino Schematic]] and  [[http://arduino.cc/en/Reference/PortManipulation|Port Manipulation]] reference page may be useful if you want to apply some of your Comp Arch experience to making your Arduino scripts write to output crazy fast.

We wired up our hardware system in the following way:
{{ :projects:fritz_diagram.jpg?600 |}}
==== Work Plan reflection ====
  * An Arduino doesn't have all that many parts to simulate. This let us get a bit ahead on understanding AVR assembly.
  * Learning assembly is complicated, and slow-going if you're trying to do it by reading lots of references between meetings for other projects. Get a feel for the basic architecture and start doing things.
  * Obscure RC cars are not documented for hackers. Luckily, RC PWM standards //are// well-documented. (hint: 50Hz, 1ms to 2ms pulses with output at 1.5ms always being halfway between the extremes.)
  * We expected to demonstrate obstacle avoidance for the final demo but 1) didn't realize that meant //demo day// and not //expo//, and 2) various hardware problems.

==== TODO ====
  * Servo control via interrupts: the existing AVR timers can only directly, simply implement two low frequency PWM waves. To add more requires more-or-less complicated interrupt structures. **But** more servos means the ability to scan with the rangefinders. So cool.
  * More complicated control logic: especially with scanning as above, it should be possible to store a rough map of the robot's surroundings. Building a roomba in assembly isn't normal, but in CompArch it is.
{{  http://static.fjcdn.com/pictures/With_28eab0_1370012.jpg?375  }}
  * Improve the panic behavior. One build, robit_no_backsie.S, tried to lock the robot into backing up until it passed a clearance threshold. For reasons that we do not entirely understand, this instead caused bizarre and inconsistent behavior, necessitating a rollback. 
  * Make a kick-ass CompArch flag, w/logo: "Rage Against the Turing Machine"?

----

===== Resources =====
==== Links ====
  * [[http://www.avr-asm-tutorial.net/avr_en/beginner/index.html | AVR assembly reference]]: Not necessarily presented in the best order but good for reference for various topics in AVR assembly. Probably worthwhile to read up on the registers and then consult as needed.
  * [[http://emulare.sourceforge.net/debugging%20with%20emulare%20and%20insight.php | Debugging with Emulare]]: Emulare is an AtMEGA simulator. While it doesn't have many bells or whistles it's useful for confirming basic features of your assembly work. Can be used with assembly debugging tools such as those bundled with WinAVR.
  * [[http://www.nongnu.org/avr-libc/user-manual/using_tools.html | Building Assembly]]: Exactly what you'd expect.
  * [[http://extremeelectronics.co.in/avr-tutorials/timers-in-compare-mode-part-i/ | AVR Timers]]: This series of articles is a good resource for timers and PWM in AVR. Read as far back as you need to given your application.
==== Files ====
{{:projects:CompArchRobit.zip}}: A .zip archive with all of our assembly. robit.S is our main working build. Similarly-named files are backups of partially functional builds or else broken test builds. Running the following from a command line/prompt will build and deploy robit.S on Com10. Change the flash.bat file as needed to reflect the actual Com Port in use.
<code>
> cd "CompArch Robit"
> make
Yes. Done. Good. :)
> flash
[...So much output... Holy cow...]
</code>

{{:projects:Robit_Movie.zip}}: An early example of the car in motion. Later builds were less likely to capsize.
ca Wiki

User Tools

Site Tools

Page Tools
