Skip to content

Stretch documentation – ev3dev2 module (aka ev3dev-stretch, library v2)#473

Closed
DrorFelman wants to merge 63 commits intojessiefrom
stretch-documentation
Closed

Stretch documentation – ev3dev2 module (aka ev3dev-stretch, library v2)#473
DrorFelman wants to merge 63 commits intojessiefrom
stretch-documentation

Conversation

@DrorFelman
Copy link
Copy Markdown

The following pages suggest that you should use the ev3dev2 module (aka ev3dev-stretch, library v2):

Nowhere does it say it hasn't been released yet.
I think this is misleading. I tried to follow this explanation and use ev3dev2, and had no idea why it was throwing errors.
Please make it more clear in the documentation.

WasabiFan and others added 30 commits September 6, 2017 17:57
* Delete virtualterminal.py
* Delete framebuffer.py
* Added class MotorSet

* Added MotorPair set_speed_ratio() and set_speed_percentage()

* Changed set_speed_ratio to set_speed_steering

* Change set_speed_steering power variable to speed

* Updated doc string for MotorPair set_ functions
* Untested implementation of friendly errors

* Fix syntax

* Use specific exception type

* Fix and test error implementation
* list the device name in 'Device not connected' Exception

* api_test.py must use python3

* Update README for tests

* Update to latest ev3dev-lang to pick up stretch fixes

* Update tests/README

* Update tests/README
* remove ev3dev-lang and autogen

* Removed the templates directory
* Reset contents of tests/motor to that of dlech/brickpi

* Switch to python3
* EV3-G API: motors

* EV3-G API: motors - fix things from code review

* Make MoveSteering a child class of MoveTank

* rename power to speed, is a % of max_speed, must be between -100 and 100

* Remove _set_position_rotations call in _set_position_degrees

* rename max_speed_pct to speed_pct

* Comment out logging in core.py
* EV3-G API: touch sensor add is_released

* Replace TABs with spaces

* TouchSensor: add wait_for_pressed, etc

* MODES to use MODE_TOUCH constant

* Only decrement timeout_ms when it is not None

* Simplify wait_for_press logic
EV3-G API infrared sensor
* Use /sys/class/board-info/ to detect platform type

* Move get_current_platform() to core.py

* PiStorms support

* Update docstrings
* Throw friendly error when device is disconnected

* Update error code
* Deprecate auto_mode

* Remove _mode_value
* EV3-G API for Button

* EV3-G API for Button - use evdev for event driven reads

* Add python-evdev as required package

* Revert "Add python-evdev as required package"

This reverts commit 2985e93.

* Undo file_open

* Update .travis.yml to install python3-evdev

* Update .travis.yml to install python3-evdev

* Update .travis.yml to 'pip install evdev'

* Option to specifiy sleep_ms in TouchSensor _wait()
* EV3-G API GyroSensor

* Drop 'raw' variable, minor cleanup
* InfraredSensor on_red_up, etc support for multiple channels

* Rename buttons red_up -> top_left, etc

* Rename buttons red_up -> top_left, etc

* Add on_ to the channel1_top_left, etc handlers
* First phase of spliting core.py

Here is what we have

robot@evb[ev3dev-lang-python]# tree ev3dev/
ev3dev/
├── button.py
├── control
│   ├── GyroBalancer.py
│   ├── __init__.py
│   └── rc_tank.py
├── display.py
├── fonts
//
// chopped most of fonts to limit the output here
//
│   ├── timR18.pbm
│   ├── timR18.pil
│   ├── timR24.pbm
│   └── timR24.pil
├── helper.py
├── __init__.py
├── led.py
├── motor.py
├── _platform
│   ├── brickpi.py
│   ├── ev3.py
│   ├── evb.py
│   ├── __init__.py
│   └── pistorms.py
├── port.py
├── sensor
│   ├── __init__.py
│   └── lego.py
├── sound.py
├── version.py
└── webserver.py

4 directories, 421 files
robot@evb[ev3dev-lang-python]#

* Fix Button(s)

* Fix Button(s)

* Fix motor(s)

* rm autogen-config.json

* remove bad imports

* Fix LEDs

* Move webserver.py to control/

* Fix tests/api_tests.py

* rm helper.py

* Unite _button and button

* Move PowerSupply from __init__.py to power.py

* sensor.py input platform specific INPUT_1, etc

* Uppercase buttons_filename and evdev_device_name constants

* Unite _led.py and led.py

* groundwork for pistorms LED support

* Do not barf if platform does not have LEDs

* raise MissingButton if platform does not have button
* Switch fake-sys submodule from rhempel to ddemidov

* Updated to latest fake-sys

* Fix board_info_dir for FAKE_SYS
ddemidov and others added 25 commits October 20, 2017 09:47
The print statement was removed with Python3, this change should work
for both Python2 and Python3.
* Remove "connected" attribute

Fixes #327

* Fix things

* I'm terrible at both staging and committing everything

* Update error name and text

* Fix things

* Revert GyroBalancer changes

* Strip exception context when device isn't connected
* adds the play_note method and changes duration parameters to seconds

* fixes invalid join() parameter

* fixes wrong delay parameter sanity check and adds a couple of comments
It seemed pretty useless to me given that we have the "tree" immediately
above it.
s/counts_per_rot/count_per_rot

See #439
* Separate GyroBalancer drive control loop from balance loop

* Add signal handlers and math.pi
Uses the new project structure in sphinx docs, fixes a couple of
docstring issues.

Fixes #441
The driver_name arg can be a single value or a list. The list is only needed
if we look for one of many options.
* Rename namespace: ev3dev -> ev3dev2

* Update api_tests.py

* Update sensor imports

* Fix all the things

* Clean up imports

* Fix reference to updated module name
* ev3dev#1026: Sound.speak does not work with double quotes

* Update to use shlex

* Remove shell=true
* "address" argument on LEDs #422

* Update git_version.py for ev3dev2 directory

* Improve Led and Leds __str__
* one line import #420

Example:

    import ev3dev2.auto as ev3

    ts = ev3.TouchSensor(ev3.INPUT_1)
* Update display for 4.14 kernel

Fixes #455
@WasabiFan
Copy link
Copy Markdown
Member

WasabiFan commented Jun 10, 2018

#411 had the documentation changes for Stretch. I wasn't merged because it still had a bit of work to do and was auto-closed when our branch structure was reconfigured; I've been preoccupied enough that I haven't come back to work on it since the beginning of the year.

As of now, I don't even think the Stretch library has been released; AFAIK it only exists on GitHub right now, and Jessie is the recommended ev3dev release anyway. That's not to say that we shouldn't prep the documentation so it's available via the stretch docs tag, but it hasn't been super high priority for me. My schedule has temporarily freed up a bit as of this past week yesterday so it's likely I can revive and finish that work.

@WasabiFan WasabiFan force-pushed the stretch-documentation branch from 5431397 to 6e87447 Compare June 10, 2018 01:01
@WasabiFan
Copy link
Copy Markdown
Member

Closing this, as it's a pull request rather than an issue and we have these changes in #411.

@Dror-89 How'd you come across that live docs page? Did search engines pick it up?

@WasabiFan WasabiFan closed this Jun 10, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.