antoniovalente / ukmarsbot

A simple beginners multi purpose robot platform

ukmarsbot

A simple beginner's multi purpose robot platform

Using inexpensive, readily available materials, components and techniques, the UK Micromouse and Robotics Society (UKMARS) has created a basic robot design that can be used in a variety of common contests such as line following, wall following, drag race and mini-sumo.

Contents

This repository is all about the robot itself. Software is provided in other UKMARS repositories.

• Software examples https://github.com/ukmars/ukmarsbot-examples
• Full maze solving software: https://github.com/ukmars/ukmarsbot-mazerunner

The repository has a number of sections:

• docs contains miscellaneous documentation and datasheets. In there are some notes about design decisions and constraints, processor choice and configuration, and a bit about sensors.
• ecad contains the design files for the various electronic modules that make up the robot. The original development was done with Eagle Version 7 since it was the last 'free' version of Eagle. More recent versions are likely to be developed in KiCad since it is free, unconstrained and multiplatform. You are only likely to need to look in here f you want to modify existing modules or create your own. Either Eagle or KiCad can be used for new development.
• hardware holds subsections for the major parts that make up the robot - the main PCB and all the sensor boards. This is where you find the outputs from the ECAD tools. You don't need to know anything about Eagle or KiCad to use these outputs. For each module you should find a set of gerbers in a zip file so that you can easily order boards from your favourite supplier. Also present should be the schematics in PDF form, images of the finished boards and a parts list (BOM) to help you populate the board and select components. Note that many component choices are up to the builder and there are a number of options possible. Some or all of these elements may be missing or incomplete. Let us know of any shortcomings by raising a new issue on github.
• mechanical contains a number of mechanical CAD files. These are most likely to be STL or STEP files and are for components that can be 3D printed tohelp you make your robot. For example you will find motor mounts and brackets here.
• renders is a place where we keep generated images of the robot and some components. You can get an idea of how your finished robot may look as well as see some of the prototypes that led to the current design.
• resources is really a dump for stuff that does not fit in with the rest. At the tie of writing this is just a section about data logging.

The Processor

Processor power is provided by the Arduino Nano board because it is very cheap and widely available. There is a huge range of sample code available for almost any purpose and support is easily found online. The Arduino software can be installed on any computer and is free.

A proposed pin usage for an Arduino Nano controller can be found in the docs folder.

because the Arduino Nano is a popular processor module, there are many compatible or near-compatible alternative boards available. The processor module socket makes it possible to use some of these directly with only small modifications or, with a little more work you might fit almost any processor. Variants have already been built with STM32 processors and even a Raspberry Pi pico and Zero board.

Bluetooth

Some alternative processors in the Arduino range already have Bluetooth and WiFi built in. If you stick with simpler options - like the Arduino Nano - there is a connector provided for you to attach one of the common HC05 or HC06 Bluetooth modules directly to the board to make a wireless serial connection. Circuitry on the board (V1.1 and later) allowyou to leave the BT module connected during programming. You can then use any serial terminal, including the Arduino terminal, to communicate with the robot over Bluetooth.

Coding

The easiest language for starting coding with the Arduino, and the method most people use, is to create a "Sketch" using the Arduino Integrated Development Environment (IDE). A "Sketch" comprises functions written with C/C++ statements and the Arduino IDE takes care of turning the sketch into a complete program and uploading it to the Arduino board. It can run on any of the major platforms: Windows, Mac and Linux enabling Sketch programs for the Arduino to be readily developed on any PC. The Arduino project has lots of examples and help available for creating code, as well as libraries of functions to carry out specific tasks.

The Arduino IDE requires software to be downloaded and installed on the development PC as well as drivers to enable the developed code to be downloaded using the USB cable onto the Arduino board. All of this software and drivers are free and easy to install as long as you have software install permissions on the PC.

There is also a recently introduced web based development environment, but as yet this does not support all Arduino models and platforms. and still requires various plug ins to be installed on the development PC to use it. Find out more here: https://www.arduino.cc/en/software

A very popular alternative to the Arduino IDE is PlatformIO which can be fully integrated into the excellent VSCode editor. A 'getting started' guide for this environment is available here: https://docs.platformio.org/en/latest/integration/ide/vscode.html

Alternative software environments are available and are identified at the end of this document.

Hardware

The robot hardware is constrained by the various contest events to be within certain dimensional limits. That means that the basic chassis will be smaller than 100mm x 100mm although add-on sensors for individual events will increase the size. The robot is designed to be multipurpose so there is a core hardware setup that provides for a basic wheelchair drive of two motors, encoder feedback for individual motor speed and a minimal interface for user interaction. Components will be modular so that substitutions are easy and to provide the greatest flexibility. Builders are free to make whatever modifications suit their purpose. For example, larger or smaller motors and wheels may be used and a variety of sensor options are possible.

Power Supply

For most purposes, the power supply for the robot will need to be compact, readily available and easy to recharge. Non rechargeable batteries are not economically viable for robot experiment and are, in any case, less environmentally friendly. Safety is a concern and so Lithium Polymer cells are only recommended when part of a regulated and protected pack. Perhaps the most common small battery is the rechargeable PP3 sized pack running at 8.4 Volts or 9 Volts. Rechargeable cells and their chargers can be purchased at supermarkets and online suppliers. More confident, or adventurous builders may install whatever power supply suits them.

Motors

While there is endless variety in small DC electric motors, the N20-based gearmotors are excellent value for money and can be purchased in a huge range of performance characteristics. An example can be found here: Pimoroni 20:1 gearmotor. The common dimensions make it easy to swap motors without changing the mechanical design of the robot. Versions are available with built-in encoders allowing for more accurate control of speed and greater precision in movement of the robot. Normally these would be used in any robot. The drivers for these motors are available on small circuit board modules that can easily be connected with the Arduino Nano.

Materials

It will be possible to build the robot using parts that are commercially readily available and specialist materials will not be required. Access to basic hand tools and soldering equipment will be necessary.

It is likely that some builders will have some access to a 3D printer or a laser cutter or both and the open design of the robot with upgrade paths will allow advanced builders to utilize these tools to create higher performing robots.

Software

The two software repositories mentioned above provide a fairly complete set of examples and code for almost every aspect of programming for the UKMARSBOT platform. Many of the techniques and examples will also be directly applicable to other mobile robot projects.

If the Arduino IDE is not for you, then there are other programming choices to suit you. (None of these have been tried by UKMARS)

• FlashForth http://flashforth.com/ is a Forth stamp system implemented on the Microchip 8-bit PIC18F and 16-bit PIC24, 30, 33 and the Atmel Atmega microcontroller families. See also https://playground.arduino.cc/CommonTopics/ForthOnArduino/ for other options relating to Forth.

• For Basic users there appear to be fewer options. One of these is Great Cow basic http://gcbasic.sourceforge.net/Typesetter/index.php/Home. "The Great Cow BASIC suite is robust and fully functional compiler and assembler. Using Great Cow BASIC is the fastest method to program a Microchip PIC or Atmel AVR 8-bit microcontroller for those just starting and the professional user." The host software is cross platform and there is a graphical editor as well as a more traditional IDE.

• Some users may prefer a visual programming environment similar to Scratch. Several of these are available and more information may be found here Sparkfun Alternative Arduino Interfaces.