GithubHelp home page GithubHelp logo

platisd / sonicdisc Goto Github PK

View Code? Open in Web Editor NEW
41.0 10.0 12.0 1.35 MB

A 360° ultrasonic scanner

License: Apache License 2.0

C++ 100.00%
atmega328p hc-sr04 ultrasonic arduino i2c interrupts automotive smartcar

sonicdisc's Introduction

SonicDisc

A 360° ultrasonic scanner that talks over I2C using an Atmega328P and eight HC-SR04 ultrasonic sensors.

sonicdisc

Overview

SonicDisc is a sensor that allows you to sense your surroundings. It utilizes 8 ultrasound sensors (HC-SR04) placed at 45° angle from each other, that can measure distances from practically every direction. It can be used in hobby-grade automotive applications, e.g. autonomous driving, obstacle detection etc or wherever quickly determining surrounding distances is relevant.

The sensor transmits the collected data over I2C and uses a separate line to signal, with a short pulse, the existence of a new set of measurements. It can be mounted on top of an Arduino UNO or used standalone. Due to the nature of the HC-SR04 sensors, the measurements can be noisy, therefore it is suggested that they are filtered. A basic Arduino example that receives and filters the incoming data can be found in examples/SonicDiscReader.

You can find the software running on the SonicDisc in firmware/, the PCB design in Eagle CAD format inside hardware/ and more sample applications using the SonicDisc in examples.

Read the story behind the module at platis.solutions.

How does it work

SonicDisc is comprised of an Atmega328P microcontroller that triggers all the ultrasound sensors at the same time, receives the echo pulses via pin change interrupts and then proceeds to calculate the detected distances. The use of interrupts, in contrast to how the HC-SR04 sensors are typically utilized, enable us to conduct all measurements at the "same" time which translates into new sets of 8 measurements every 10 milliseconds.

As an I2C slave, whenever a new set of measurements is ready to be transmitted, a short pulse is sent over the INT pin, prompting the master to request the data. In other words the I2C master reading the data from the SonicDisc, does not have to poll but merely wait for the indicative signal and then make the I2C request. Despite not suggested, it is possible to use SonicDisc without connecting the INT pin to an interrupt, however the master will not be able to assure the existence of a new data.

How to connect

SonicDisc Host MCU
VCC 5V
GND GND
SDA SDA
SCL SCL
INT ISR

If you are mounting the SonicDisc on top of an Arduino UNO as a shield, you only have to (optionally but suggested) connect the INT signal to an ISR pin.

I2C protocol

SonicDisc communicates using the I2C bus as a slave, meaning that it receives data from a master and responds to data requests.

Address

SonicDisc's I2C address is currently hardcoded to 0x09.

Set operational state

SonicDisc has two operational states between which you can switch.

Action Byte to send Notes
Set state to STANDBY 0x0A SonicDisc's initial state
Set state to MEASURING 0x0B Set to this state to start the measurements

Arduino example:

Wire.beginTransmission(0x09);
Wire.write(0x0B); // Instruct SonicDisc to start measuring
Wire.endTransmission(0x09);

Get data

SonicDisc responds to I2C requests with packages of 9 bytes that include an error code and sensor measurements. A typical package structure is described below.

Regarding the error codes, when the first byte is a 0 then everything went well and the trailing measurements are valid. If it is 1, it means that this set of data has already been transmitted and a measurement is currently under way. You will encounter this if you poll the sensor fast enough, without taking into consideration the INT signal which indicates SonicDisc is ready to transmit new data. Finally, 2 designates that the module is in standby state and no measurements are being conducted.

Byte Index Range Purpose Notes
0 0-2 Error code 0: No error, 1: Incomplete measurement, 2: In standby state
1 0-255 Ultrasonic 0 0: Error in measurement, 1: TBD, 2-255: Valid distance (cm)
2 0-255 Ultrasonic 1 0: Error in measurement, 1: TBD, 2-255: Valid distance (cm)
3 0-255 Ultrasonic 2 0: Error in measurement, 1: TBD, 2-255: Valid distance (cm)
4 0-255 Ultrasonic 3 0: Error in measurement, 1: TBD, 2-255: Valid distance (cm)
5 0-255 Ultrasonic 4 0: Error in measurement, 1: TBD, 2-255: Valid distance (cm)
6 0-255 Ultrasonic 5 0: Error in measurement, 1: TBD, 2-255: Valid distance (cm)
7 0-255 Ultrasonic 6 0: Error in measurement, 1: TBD, 2-255: Valid distance (cm)
8 0-255 Ultrasonic 7 0: Error in measurement, 1: TBD, 2-255: Valid distance (cm)

Arduino example:

const unsigned int PACKET_SIZE = 9;
unsigned int packet[PACKET_SIZE] = {0};
unsigned int packetIndex = 0;
Wire.requestFrom(0x09, PACKET_SIZE);
while (Wire.available() && packetIndex < PACKET_SIZE) {
    i2cInput[packetIndex++] = Wire.read();
}
// Now the packet[] array holds the incoming data from SonicDisc

Build one yourself

Below you can find the necessary components to build a SonicDisc yourself:

  • SonicDisc PCB
  • 8 x HC-SR04
  • 1 x Atmega328P-PU
  • 2 x 22pF capacitors
  • 3 x 0.1uF capacitors
  • 1 x 1206 LED
  • 1 x 1206 220Ω resistor
  • 3 x 4.7KΩ resistor
  • 1 x 5-pin header
  • 1 x 4-pin header
  • 1 x tactile switch
  • 1 x 16MHz oscillator
  • 1 x ISCP pin header
  • 1 x 10-pin stackable header
  • 2 x 8-pin stackable header
  • 1 x 6-pin stackable header

Derivative works

sonicdisc's People

Contributors

platisd avatar richardfirth avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

sonicdisc's Issues

Reset button for host Arduino

As an Arduino user I want to be able to reset my Arduino through the SonicDisc so to be able to easily restart the sketches.

SonicDisc is large enough to cover the reset button in the Arduino UNO and makes it harder to access.

Uno's DC jack is in the way when mounted

When the SonicDisc is mounted on top of an Arduino UNO the UNO's DC jack touches one of the sensors (Ultrasonic 7). Moving the footprint of the sensor a few millimeters outward should fix the problem.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.