Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create "common issues" page and include BrickPi info #731

Open
wants to merge 3 commits into
base: ev3dev-stretch
Choose a base branch
from
Open

Create "common issues" page and include BrickPi info #731

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d5099c2
Create "common issues" page and include BrickPi info
WasabiFan Mar 23, 2020
6ebff88
WIP
WasabiFan Mar 26, 2020
5edc193
update common issues page
WasabiFan Mar 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ This repository holds the Python bindings for ev3dev_, ev3dev-lang-python.
Opening issues
--------------

Please make sure you have read the FAQ_. If you are still encountering your
problem, open an issue, and ensure that the questions asked by the issue
template are completely answered with correct info. This will make it much
easier for us to help you!
Please make sure you have read the FAQ_ and `Common Issues`_. If you are still
encountering your problem, open an issue, and ensure that the questions asked
by the issue template are completely answered with correct info. This will make
it much easier for us to help you!

Submitting Pull Requests
------------------------
Expand Down Expand Up @@ -105,3 +105,4 @@ following commands:

.. _ev3dev: http://ev3dev.org
.. _FAQ: https://python-ev3dev.readthedocs.io/en/ev3dev-stretch/faq.html
.. _Common Issues: http://python-ev3dev.readthedocs.io/en/ev3dev-stretch/common-issues.html
6 changes: 4 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ If you encounter an error such as
``/usr/bin/env: 'python3\r': No such file or directory``,
you must switch your editor's "line endings" setting for the file from
"CRLF" to just "LF". This is usually in the status bar at the bottom.
For help, see `our FAQ page`_.
For help, see our `Common Issues page`_.

Important: Make your script executable (non-Visual Studio Code only)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -202,7 +202,8 @@ Frequently-Asked Questions
--------------------------

Experiencing an odd error or unsure of how to do something that seems
simple? Check our our `FAQ`_ to see if there's an existing answer.
simple? Check our our `FAQ`_ and `Common Issues page`_ to see if there's an
existing answer.


.. _ev3dev: http://ev3dev.org
Expand All @@ -218,6 +219,7 @@ simple? Check our our `FAQ`_ to see if there's an existing answer.
.. _ev3python.com: http://ev3python.com/
.. _FAQ: http://python-ev3dev.readthedocs.io/en/ev3dev-stretch/faq.html
.. _our FAQ page: FAQ_
.. _Common Issues page: http://python-ev3dev.readthedocs.io/en/ev3dev-stretch/common-issues.html
.. _our Issues tracker: https://github.com/ev3dev/ev3dev-lang-python/issues
.. _EXPLOR3R: demo-robot_
.. _demo-robot: http://robotsquare.com/2015/10/06/explor3r-building-instructions/
Expand Down
31 changes: 31 additions & 0 deletions docs/common-issues.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
Common Issues with ev3dev-lang-python
=====================================

``/usr/bin/env: 'python3\r': No such file or directory``
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another issue (possibly more common than this one) is "no module named ev3dev2". This is usually caused by users running the program on their computer instead of the EV3.

e.g. #539 (comment)

--------------------------------------------------------

This means your file includes Windows-style line endings
(CRLF--carriage-return line-feed), which are often inserted by editors on
Windows. To resolve this issue, open an SSH session and run the following
command, replacing ``<file>`` with the name of the Python file you're
using:

.. code:: shell

sed -i 's/\r//g' <file>

This will fix it for the copy of the file on the brick, but if you plan to edit
it again from Windows, you should configure your editor to use Unix-style
line endings (LF--line-feed). For PyCharm, you can find a guide on doing this
`here <https://www.jetbrains.com/help/pycharm/2016.2/configuring-line-separators.html>`_.
In Visual Studio Code, there is an option in the lower-right corner.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think most users are using VS Code these days, so maybe list this one first with a screenshot?

Most other editors have similar options; there may be an option for it in the
status bar at the bottom of the window or in the menu bar at the top.


``Exception: Unsupported platform 'None'``
------------------------------------------

You probably forgot to `update config.txt`_.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be good to mention that this only applies to Raspberry Pi.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On BrickrPi3, there is also the common issue of "my sensors don't work". Solution is to copy https://github.com/ev3dev/ev3dev-lang-python-demo/blob/stretch/platform/brickpi3-motor-and-sensor.py


.. _update config.txt: https://www.ev3dev.org/docs/getting-started/#step-3a-raspberry-pi-only-update-options-in-configtxt
19 changes: 2 additions & 17 deletions docs/faq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,7 @@
Frequently-Asked Questions
==========================

Q: Why does my Python program exit quickly or immediately throw an error?
A: This may occur if your file includes Windows-style line endings
(CRLF--carriage-return line-feed), which are often inserted by editors on
Windows. To resolve this issue, open an SSH session and run the following
command, replacing ``<file>`` with the name of the Python file you're
using:

.. code:: shell

sed -i 's/\r//g' <file>

This will fix it for the copy of the file on the brick, but if you plan to edit
it again from Windows, you should configure your editor to use Unix-style
line endings (LF--line-feed). For PyCharm, you can find a guide on doing this
`here <https://www.jetbrains.com/help/pycharm/2016.2/configuring-line-separators.html>`_.
Most other editors have similar options; there may be an option for it in the
status bar at the bottom of the window or in the menu bar at the top.
See also `Common Issues`_.

Q: Where can I learn more about the ev3dev operating system?
A: `ev3dev.org`_ is a great resource for finding guides and tutorials on
Expand Down Expand Up @@ -63,6 +47,7 @@ Q: What compatibility issues are there with the different versions of Python?
.. _ev3python.com: http://ev3python.com/
.. _FAQ: http://python-ev3dev.readthedocs.io/en/ev3dev-stretch/faq.html
.. _our FAQ page: FAQ_
.. _Common Issues: http://python-ev3dev.readthedocs.io/en/ev3dev-stretch/common-issues.html
.. _our Issues tracker: https://github.com/ev3dev/ev3dev-lang-python/issues
.. _EXPLOR3R: demo-robot_
.. _demo-robot: http://robotsquare.com/2015/10/06/explor3r-building-instructions/
Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@
spec
rpyc
faq
common-issues
2 changes: 2 additions & 0 deletions docs/sensors.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ Sensor classes
*Note:* If you are using a BrickPi rather than an EV3, you will need to manually
configure the ports before interacting with your sensors. See the example
`here <https://github.com/ev3dev/ev3dev-lang-python-demo/blob/stretch/platform/brickpi3-motor-and-sensor.py>`_.
There are other common issues specific to the BrickPi; check out `Common Issues`_.

.. _Common Issues: http://python-ev3dev.readthedocs.io/en/ev3dev-stretch/common-issues.html

Dedicated sensor classes
------------------------
Expand Down