https://github.com/kevinmcaleer/smars
Screwless Modular Assemblable Robotic System
https://github.com/kevinmcaleer/smars
arduino python raspberry-pi raspberry-pi-zero-wh robot robotics smars
Last synced: about 1 year ago
JSON representation
Screwless Modular Assemblable Robotic System
- Host: GitHub
- URL: https://github.com/kevinmcaleer/smars
- Owner: kevinmcaleer
- Created: 2018-09-12T08:03:37.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-10-19T08:25:32.000Z (over 5 years ago)
- Last Synced: 2025-05-05T15:03:52.600Z (about 1 year ago)
- Topics: arduino, python, raspberry-pi, raspberry-pi-zero-wh, robot, robotics, smars
- Language: Python
- Size: 15.5 MB
- Stars: 32
- Watchers: 4
- Forks: 11
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# SMARS
Screwless Modular Assemblable Robotic System
## SMARSfan.com
Visit www.smarsfan.com for more information about this project. The site includes build instructions, videos, an interview with the designer and much more.
## SMARSLab & SMARS_Library
I've broken the SMARS code into two parts:
SMARS_Library is a component that can now be installed via
```console
pip install smars-library
```
or visiting
SMARSLab is a web-based application for controlling your SMARS robots. The aim it that this will support both bluetooth connected wheeled SMARS as well as ones running locally on a raspberry pi zero. It currently supports QUAD SMARS and there is a test `butil.py` app for testing bluetooth connectivity.
Visit for more information.
## About this library
This library will enable you to get the quad robot walking and detecting its environment.
## Python Library now pulls from pip
There is now a SMARS Python library available via pip.
***Make sure you follow the instructions below to ensure the virtual environment is setup correctly and everything should work perfectly.***
## Setup a virtual environment
The best way to ensure all the right prerequisites are installed and the supported version of python is installed is by setting up a virtual environment for python.
To Install virtualenv:
* log on to your raspberry pi
* install virtualenv:
```console
sudo apt-get install virtualenv
```
* create a new virtual python environment:
```console
virtualenv -p python3 venv
```
* activate the new python environment:
```console
source venv/bin/activate
```
* install the pre-requisites:
```console
pip install -r requirements.txt
```
* to deactivate the environment once you have finished, type
```console
deactivate
```
## Files
```.
├── Documentation - All the Documents
│ └── SMARS Build Instructions
│ └── Build instructions.pdf - PDF version of the build instructions
├── limb_setup.py - script for helping setup limbs on a QUAD SMARS
├── pinouts.md - Describes the pinouts for the PCA9685
├── README.md - this file
├── requirements.txt - used by pip to install the prerequisites
├── S-Code.md - a code similar to G-Code for sending commands to a SMARS, work in progress
├── S-CodeParse.py - a parser for S-Code
├── Scratch 1.4
│ └── SMARSScratchDemo.sb - an example Scratch 1.4 file for communicating with SMARS
├── ScratchListener.py - the lister app for communicating with SMARS and Scratch
├── setup.sh - a shell script for setting up the code on a raspberry pi
├── SMARS_ultrasonic_demo
│ └── SMARS_ultrasonic_demo.ino - a sample Arduino script for using the ultrasonic sensor
├── STL_Files - some STL files for modified tracks
│ ├── Track 18mm.png
│ ├── Track 18mm.stl
│ ├── Track 20.5mm 16h.stl
│ ├── Track 20.5mm.stl
│ ├── Track 205mm.stl
│ ├── Track 210mm.stl
│ └── Track.png
└── test - the test suite
├── test.md - test suite documentation
├── test.py - a simple test app for checking your SMARS setup
└── test_suite.py - the test suite used by Travis-CI to confirm build quality
```
## Scratch 1.4 Code
The Library now includes a sample Scratch 1.4 script that will enable you to control your SMARS Quad robot from the scratch environment. Please note you will need to enable the remote sensor control for this to work, by right clicking on the sensor and clicking on 'enable remote sensing'.
The Scratch demo script needs to communicate with the Python 'ScratchListener.py' code, and you will need to know the IP address of the computer running Scratch 1.4.
Note only Scratch 1.4 has the 'enable remote sensing' option available, Scratch 2.0 & Scratch 3.0 do not allow this, however you can still download and use Scratch 1.4 from the Scratch website:
Link to thingiverse original model:
Link to Quad version
## Overview and Background
This robot is really easy and cheap to 3d print, build and program. It can be assembled without screws or soldering and it's modular so it can be adapted for different purposes. I'm Swiss, so I don't know American scholastic system but I would use SMARS in last year of middle school, high school or universities/ colleges. There is more "open electronics" compared to a Lego NXT or similar, so students need a few knowledges about security, electrical laws and so on. It can be use to improve software development skills, CAD skills or electronics skills, students can design their own modules and customize their SMARS.
### Programming SMARS
You can use most common small hardware platforms as the brains inside SMARS, the Arduino platform (and compatible) was used in the original design as its cheap, commonly available, and the tools for programming it are easy to use. For the quad version of the robot a Raspberry Pi Zero was used. The language commonly used on the Pi (and where it gets it name from) is Python. A library module has been written for both Arduino and Python to help you get started.
### Getting the Arduino IDE
Visit to download the latest Arduino Integrated Development Environment (IDE).