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.

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

docs : Improved REPL information regarding serial terminals screen and picocom #621

Merged
merged 18 commits into from
Jan 4, 2019
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
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
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,20 @@ with an ARM compiler toolchain (eg arm-none-eabi-gcc and friends).
Ubuntu users can install the needed packages using:
```
sudo add-apt-repository -y ppa:team-gcc-arm-embedded
sudo add-apt-repository -y ppa:pmiller-opensource/ppa
sudo apt-get update
sudo apt-get install cmake ninja-build gcc-arm-none-eabi srecord libssl-dev
pip3 install yotta
sudo apt-get install gcc-arm-embedded
sudo apt-get install cmake ninja-build srecord libssl-dev
sudo -H pip3 install yotta
```

Download the project, clicking the `Download or clone` button above, then select
`Download zip`. This will place a `micropython-master.zip` in your `~/Dowloads`
directory. Unzip it and change to that directory

```
cd ~/Downloads
unzip micropython-master.zip
cd micropython-master
```

Once all packages are installed, use yotta and the provided Makefile to build.
Expand Down
30 changes: 23 additions & 7 deletions docs/devguide/repl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,16 +78,32 @@ In PuTTY:

**Mac OS**

Open Terminal and type ``screen /dev/cu.usbmodem1422 115200``, replacing
``/dev/cu.usbmodem1422`` with the port you found earlier. This will open the
micro:bit's serial output and show all messages received from the device. To
exit, press Ctrl-A then Ctrl-D.
Open Terminal and type ``screen /dev/cu.usbmodem1422 115200``, replacing
``/dev/cu.usbmodem1422`` with the port you found earlier. This will open the
micro:bit's serial output and show all messages received from the device.

To exit, press Ctrl-A then Ctrl-\\ and answer Yes to the question. There are
many ways back to a command prompt including Ctrl-A then Ctrl-D, which will
detach screen, but the serial port with still be locked, preventing other
applications from accessing it. You can then restart screen by typing
``screen -r``. Typing ``screen /dev/cu.usbmodem1422 115200`` results in rather
microbit-carlos marked this conversation as resolved.
Show resolved Hide resolved
unhelpful error output ``[screen is terminating]``


**Linux**

Using the ``screen`` program, type ``screen /dev/ttyUSB0 115200``, replacing
Using the ``screen`` program, type ``screen /dev/ttyUSB0 115200``, replacing
``/dev/ttyUSB0`` with the port you found earlier.

Using ``picocom``, type ``picocom /dev/ttyACM0 -b 115200``, again replacing
``/dev/ttyACM0`` with the port you found earlier.
To exit, press Ctrl-A then \\ and answer Yes to the question. There are many
ways back to a command prompt including Ctrl-A then Ctrl-D, which will detatch
rhubarbdog marked this conversation as resolved.
Show resolved Hide resolved
screen. All serial output from the micro:bit will still be received by
``screen``, the serial port will be locked, preventing other applications from
accessing it. You can restart screen by typing ``screen -r``. Typing
microbit-carlos marked this conversation as resolved.
Show resolved Hide resolved
``screen /dev/ttyUSB0 115200`` results in rather unhelpful error output
``[screen is terminating]``

Using ``picocom``, type ``picocom /dev/ttyACM0 -b 115200``, again replacing
``/dev/ttyACM0`` with the port you found earlier.

To exit, press Ctrl-A then Ctrl-Q.