ericksimoes / ultrasonic Goto Github PK

• spelling of the author's name;
• update date (version 0.1);
• license.

The issue #30 requires that wiring image be updated with a Seed Studio sensor.

The layout of folders and files should follow the new specification of libraries:
See Arduino documentation

Update number version and create a new tag.

It is written "Import library", the correct is "Include Library", on README file.

In C / C ++ object names do not necessarily accurately begin with capital letter.

hi there

Thank you very much for the library.
I have created a simulation page for the Ultrasonic sensor library here:.
https://wokwi.com/arduino/projects/296099969420493322

It is a permanent page and it gives an opportunity for your future library users to play with the library and get a feel of it even before they integrate the library into their own project.

Kindly let me know what you think!

If you feel it is good, I would love to create a PR to add the simulation link in the ReadMe file.

Thanks a lot!
Puneeth

Currently the constants referring to sound speed can not be modified by the API, just by modifying the code manually.
Consider allowing the value to be passed as a parameter, as a setting.

Add references to a new modules suported.

The name distanceRead() is too long.
To be more friendly, and less verbal, it may can be something like read()

Warning: In member function 'int Ultrasonick::distanceRead()'

\Ultrasonick\src\Ultrasonick.cpp:52:1

Timeouts are a new feature and need some examples.

It is currently outdated.

Why is the time of the answer on the echo-Pin used for distance calculations?? The resulting values are fluctuating strongly.
They are also far worse than calculations based on the runtime of the plus?
This design decision seems to be a "wrong" choice. I noticed this while using the library and couldn't isolate the fluctuating measurements I got while using the sensor because it came from this library with over 1500 uses on Platform IO.
I am somewhat puzzled that the way the time is measured can at all be used for distance calculations!!

The license is poorly defined.
It is necessary to choose a permissive license, which projects the copyright and stimulates the external contribution.

The method can be simplified if the constants CM and INC represent the divisors, like this:

unsigned int Ultrasonic::distanceRead(uint8_t divisor) {
    return timing() / divisor / 2;
}

In the README file there is a topic about the license that is unattended.

The Ultrasonic module of Seeed Studio is diferent of HC-SR04.
It has only one reading and writing pin.

See documentation: http://wiki.seeed.cc/Ultra_Sonic_range_measurement_module/

There are many old commits with title and description in Portuguese.
In order to internationalize this project, it is important to translate into English.

Hi! I'm using an older version of Madsonic server, latest free, without activation (MADSONIC 5.1.5260.20150831.0820) and after your latest update your android client can't connect to server. (A network error ocurred. Please check the server address or try again.)
Thank you for all your work!

"Library for HC-SR04 Ultrasonic Ranging Module in a minimalist way"

The latest Arduino library specification recommends that there be a library.properties file at the root of the project.
This file should follow the pattern specified here.

int type is unnecessarily large.

I used your library today in VS Code, I verified the code on Arduino UNO board,

the IDE said: 'class Ultrasonic' has no member named 'read'

by the intellisense function, I knew it was "distanceRead()" rather than "read()", so maybe there need an update in your example code in PlatformIO extension for VS Code.

Classes are useful, but their performance is less than using structs (given due proportions).
Therefore, it may be interesting to adopt the use of structs where classes are used today. Considering that one of the objectives of this library is to be minimal and optimized, consuming as few resources as possible.

This references is from #61

Explain that it is possible to use 3 pin sensors.

The issue #30 requires that the documentation be updated.

The issue #30 requires new examples files using Seed Studio Ultrasonic Sensor.

Translate README file to Brazilian portuguese

Description
The README.md file is available in English only. To expand the reach of this lib, it is important that it be available in other languages.

Apparently, when this library is used on a non-Arduino-based device, the pulseIn() method, used to wait the echo, causes incompatibility problems.
To prevent any future problems, is recommended to use another strategy to read the length of the pulse (in microseconds), like using micros().

In the files Ultrasonick.h and Ultrasonick.cpp are incluided Arduino.h.

It is necessary to investigate cases where the returned value can be negative.
In such cases you must ensure that only values equal to or greater than zero can be returned.

There are minor fixes to be made to this file:

• Line size;
• Spelling of the author's name;
• Document that by passing INC as a parameter to the distanceRead() method it will be possible to obtain the distance in inches;
• Update library site;
• Document that pins are not necessarily 12 and 13;
• Define update date (after creation date);

Translate README file to Spanish.

Description
The README.md file is available in English only. To expand the reach of this lib, it is important that it be available in other languages.

Now is possible install the library via IDE.
This should be documented in the README.md

A 30 millisecond delay after trigger is a huge time (Ultrasonic.cpp@48).
Maybe was 30 microseconds?

Old IDEs of Arduino haven't support to Arduino.h library.
To keep the most hight compatibility, is important to use the #include <WProgram.h> code block.

The comments are very long, in some cases taking up 10 lines.

To improve readability, I recommend putting only references to the latest update. The history of who created or contributed is already registered on GitHub itself.

The excerpt present at the beginning of the archives .h e .cpp:

#if (ARDUINO >= 100)
  #include "Arduino.h"
#else
  #include "WProgram.h"
#endif

can be removed.

Describe the bug
Code loads, Serial monitor prints line statements but measurement value is always 0

Code to reproduce

#include <Ultrasonic.h>

Ultrasonic myUltrasonicSensor(5);
int distance;

void setup() {
  Serial.begin(9600);
}

void loop() {
  // Pass INC as a parameter to get the distance in inches
  distance = myUltrasonicSensor.read();
  
  Serial.print("Distance in CM: ");
  Serial.println(distance);
  delay(1000);
}

Wiring
Connected to a Seead Senor Shield

Expected behavior
As Sensor is moved distance value should show distance to object

Error message
none

Context (please complete the following information):

• OS: [e.g. Windows x64]
• IDE version: [e.g. Arduino 1.8.5]
• Sensor: [e.g. HC-SC04]
• Library version [e.g. 2.1.0]

• Add image and description about wiring;
• Change ultrasound for ultrasonic (to help with library searches)
• Add link to download of .zip;
• Stylize text (add bold and italic where necessary, highlighting important words);
• Update link to twitter of author.

The underscore has been placed to signal which variables are private, but this is not elegant.
Using the static keyword can solve this visibility issue.