diff options
Diffstat (limited to 'docs/tutorial/script.rst')
-rw-r--r-- | docs/tutorial/script.rst | 105 |
1 files changed, 105 insertions, 0 deletions
diff --git a/docs/tutorial/script.rst b/docs/tutorial/script.rst new file mode 100644 index 0000000000..9b1df408fd --- /dev/null +++ b/docs/tutorial/script.rst @@ -0,0 +1,105 @@ +Running your first script +========================= + +Let's jump right in and get a Python script running on the pyboard. After +all, that's what it's all about! + +Connecting your pyboard +----------------------- + +Connect your pyboard to your PC (Windows, Mac or Linux) with a micro USB cable. +There is only one way that the cable will connect, so you can't get it wrong. + +<img src="/static/doc/pyboard-usb-micro.jpg" alt="pyboard with USB micro cable" style="width:200px; border:1px solid black; display:inline-block;"/> + +When the pyboard is connected to your PC it will power on and enter the start up +process (the boot process). The green LED should light up for half a second or +less, and when it turns off it means the boot process has completed. + +Opening the pyboard USB drive +----------------------------- + +Your PC should now recognise the pyboard. It depends on the type of PC you +have as to what happens next: + + - **Windows**: Your pyboard will appear as a removable USB flash drive. + Windows may automatically pop-up a window, or you may need to go there + using Explorer. + + Windows will also see that the pyboard has a serial device, and it will + try to automatically configure this device. If it does, cancel the process. + We will get the serial device working in the next tutorial. + + - **Mac**: Your pyboard will appear on the desktop as a removable disc. + It will probably be called "NONAME". Click on it to open the pyboard folder. + + - **Linux**: Your pyboard will appear as a removable medium. On Ubuntu + it will mount automatically and pop-up a window with the pyboard folder. + On other Linux distributions, the pyboard may be mounted automatically, + or you may need to do it manually. At a terminal command line, type ``lsblk`` + to see a list of connected drives, and then ``mount /dev/sdb1`` (replace ``sdb1`` + with the appropriate device). You may need to be root to do this. + +Okay, so you should now have the pyboard connected as a USB flash drive, and +a window (or command line) should be showing the files on the pyboard drive. + +The drive you are looking at is known as ``/flash`` by the pyboard, and should contain +the following 4 files: + + - [``boot.py``](/static/doc/fresh-pyboard/boot.py) -- this script is executed when the pyboard boots up. It sets + up various configuration options for the pyboard. + + - [``main.py``](/static/doc/fresh-pyboard/main.py) -- this is the main script that will contain your Python program. + It is executed after ``boot.py``. + + - [``README.txt``](/static/doc/fresh-pyboard/README.txt) -- this contains some very basic information about getting + started with the pyboard. + + - [``pybcdc.inf``](/static/doc/fresh-pyboard/pybcdc.inf) -- this is a Windows driver file to configure the serial USB + device. More about this in the next tutorial. + +Editing ``main.py`` +------------------- + +Now we are going to write our Python program, so open the ``main.py`` +file in a text editor. On Windows you can use notepad, or any other editor. +On Mac and Linux, use your favourite text editor. With the file open you will +see it contains 1 line:: + + # main.py -- put your code here! + +This line starts with a # character, which means that it is a *comment*. Such +lines will not do anything, and are there for you to write notes about your +program. + +Let's add 2 lines to this ``main.py`` file, to make it look like this:: + + # main.py -- put your code here! + import pyb + pyb.LED(4).on() + +The first line we wrote says that we want to use the ``pyb`` module. +This module contains all the functions and classes to control the features +of the pyboard. + +The second line that we wrote turns the blue LED on: it first gets the ``LED`` +class from the ``pyb`` module, creates LED number 4 (the blue LED), and then +turns it on. + +Resetting the pyboard +--------------------- + +To run this little script, you need to first save and close the ``main.py`` file, +and then eject (or unmount) the pyboard USB drive. Do this like you would a +normal USB flash drive. + +When the drive is safely ejected/unmounted you can get to the fun part: +press the RST switch on the pyboard to reset and run your script. The RST +switch is the small black button just below the USB connector on the board, +on the right edge. + +When you press RST the green LED will flash quickly, and then the blue +LED should turn on and stay on. + +Congratulations! You have written and run your very first Micro Python +program! |