API documentaton for the GPG Distance and IMU sensors?

[jimrh]

Greetings yet again!

I am playing around with the various methods in the EasyGoPiGo libraries, and I want to mess with the line-follower, distance sensor, and IMU sensor.

I have found information about the line-follower, but not the distance or IMU sensors.

I am sure I could go wandering around the various GitHub repos, but I am curious if there is any True and Authorized documentation for the sensor API’s within the EasyGoPiGo libraries?

@cleoqc, if you’re using the “stay at home orders” as a time to catch up on documentation, maybe this could be on the list too?

For example:
I could mess around with the Remote Camera Robot code to include input from the distance sensor and Charlie’s front bumper for object avoidance.

[cleoqc]

Are you looking for this? https://di-sensors.readthedocs.io/en/master/

[jimrh]

Interesting!

This is precisely what I needed.

Perusing your site before - or maybe someone sent me the link, I don’t remember - I found this set of pages:
https://gopigo3.readthedocs.io/en/master/about.html

Perhaps this is an older, depreciated, set of doc’s?  This includes the Grove “Ultrasonic Sensor” but no distance sensor or IMU.

(Update - replacing much of the original post)

Ahhh!  I see. . . .  This is an entirely separate manual for certain - more advanced - sensors that supplements, but does not replace, the existing EasyGoPiGo documentation.

Suggestion:
Maybe the documents can point to each other?
(i.e.  The EasyGoPiGo documentation can mention that certain sensors are included in the Di-Sensors doc, and the Di-Sensors doc can reference back to the EasyGoPiGo documentation.)

Thanks hugely!!

[jimrh]

One last suggestion that would improve both documents tremendously:

At the beginning of each section dealing with a particular sensor or actuator, include a “requires” or “requirements” section listing the include files needed for that particular sensor/actuator.

Why?

First, the statement of what to include is located on a completely different page  than the sensor API documentation.

Second, the document is organized - very nicely, I might add - with links to individual sections for specific sensors/actuators, so that the user can click directly on the topic of interest without  having to wade through a ream of documentation.

Because of this, pre-requisites that are mentioned some distance away will not be seen.  Including them within the particular section points out precisely what’s needed to make that particular  sensor work.

Thanks!

[jimrh]

Sorry, something else. . .

I looked at the “depreciated” methods in the EasyGoPiGo3 library documentation as mentioned in the original posting above, and noticed that all the “EasyGoPiGo” methods are now part of “easy.sensors”  In fact, it looks like the entire EasyGoPiGo3 library has been depreciated.

Though the very beginning of each section mentions that they’re based on “easy.sensors”, the example code  (which people will believe is Gospel), is all based on EasyGoPiGo3.

Viz.:

Class for controlling servo motors with the GoPiGo3 robot. Allows you to rotate the servo by serving [specifying?] the angle of rotation.

This class is derived from [the] Sensor class and because of this, it inherits all the attributes and methods.

For creating a Servo object we need to call [the] init_servo() method like in the following examples[:]

#create an EasyGoPiGo3 object
gpg3_obj = EasyGoPiGo3()

# and now let's instantiate a Servo object through the gpg3_obj object
# this will bind a servo to port "SERVO1"
servo = gpg3_obj.init_servo()
# (Apparently "servo1" is the default value, though default values are not mentioned.)

# rotate the servo at 160 degrees
servo.rotate_servo(160)

Or if we want to specify the port to which we connect the servo, we need to call init_servo() the following way[:]

servo = gpg3_obj.init_servo("SERVO2")