Merge pull request #41 from RaspberryPiFoundation/dev

0.0.2

Author: Martin O'Hanlon

docs/api.rst

@@ -32,35 +32,58 @@ RGBLED
     :inherited-members:
     :members:
 
-Button
+Buzzer
 ------
 
-.. autoclass:: Button
+.. autoclass:: Buzzer
     :show-inheritance:
     :inherited-members:
-    :members:
+    :members: 
 
-Switch
-------
+PWMBuzzer
+---------
 
-.. autoclass:: Switch
+.. autoclass:: PWMBuzzer
     :show-inheritance:
     :inherited-members:
     :members: 
 
+Speaker
+-------
+
+.. autoclass:: Speaker
+    :show-inheritance:
+    :inherited-members:
+    :members: 
 
-RGBLED
+Button
 ------
 
-Buzzer
+.. autoclass:: Button
+    :show-inheritance:
+    :inherited-members:
+    :members:
+
+Switch
 ------
 
-Speaker
--------
+.. autoclass:: Switch
+    :show-inheritance:
+    :inherited-members:
+    :members: 
 
 Potentiometer
 -------------
 
+.. autoclass:: Potentiometer
+    :show-inheritance:
+    :inherited-members:
+    :members: 
+
 TemperatureSensor
 -----------------
 
+.. autoclass:: TemperatureSensor
+    :show-inheritance:
+    :inherited-members:
+    :members: 

docs/changelog.rst

@@ -3,7 +3,8 @@ Change log
 
 .. currentmodule:: picozero
 
-0.0.0 - yyyy-mm-dd
+0.0.1 - 2022-03-21
 ~~~~~~~~~~~~~~~~~~
 
-+ these things were released
++ Initial alpha release to test installation process
+

docs/developing.rst

@@ -1,23 +1,16 @@
 Development
 ===========
 
-Instructions on how to test, build and deploy picozero.
-
-Test
-----
-
-Not sure...  pytest can probably be used but would have to mock `machine`.
+Instructions on how build and deploy picozero.
 
 Build
 -----
 
-1. Strip comments and docstrings from the source code to reduce file size (somehow).
-
-2. Run `setup.py` and create a source distribution.:
+1. Run `setup.py` and create a source distribution.:
 
     python3 setup.py sdist
 
-3. Upload to PyPI:
+2. Upload to PyPI:
 
     twine upload dist/*
 
@@ -36,3 +29,4 @@ To build the documentation, run the following command from the docs directory:
 
 The website will be built in the directory docs/_build/html.
 
+Documentation can be viewed at http://picozero.readthedocs.io/

docs/gettingstarted.rst

@@ -1,8 +1,108 @@
+.. picozero: a library for controlling Raspberry Pi Pico GPIO pins with MicroPython
+..
+.. SPDX short identifier: MIT
+
 Getting Started
 ===============
 
-How to install...
+Requirements
+------------
+
+A Windows, macOS or Linux computer with the `Thonny Python IDE`_ installed.
+
+.. _Thonny Python IDE: https://thonny.org/
+
+You can find information on how to install Thonny on the `Introduction to Raspberry Pi Pico guide`_.
+
+.. _Introduction to Raspberry Pi Pico guide: https://learning-admin.raspberrypi.org/en/projects/introduction-to-the-pico/2
+
+Once Thonny is installed you will need to ensure that you are using the latest MicroPython firmware. Details on how to install or update the Raspberry Pi Pico MicroPython firmware can be found on the `guide`_.
+
+.. _guide: https://learning-admin.raspberrypi.org/en/projects/introduction-to-the-pico/3
+
+Use the MicroPython interpreter
+-------------------------------
+
+In Thonny, on the bottom right of the screen, there are options for changing the interpreter that you are using. Make sure that **MicroPython (Raspberry Pi Pico)** is selected.
+
+.. image:: images/thonny-switch-interpreter.jpg
+
+Install picozero from PyPi in Thonny
+------------------------------------
+
+To install picozero within Thonny select **Tools** > **Manage packages...**
+
+.. image:: images/thonny-manage-packages.jpg
+
+Search for `picozero` on PyPi.
+
+.. image:: images/thonny-packages-picozero.jpg
+
+Click on install to download the package.
+
+.. image:: images/thonny-install-package.jpg
+
+Other install options
+---------------------
+
+You can use the Thonny file manager to transfer a ``picozero.py`` file to Raspberry Pi Pico.
+
+From the **View** menu, choose to see files.
+
+.. image:: images/thonny-view-files.jpg
+
+Either clone the picozero `GitHub repository`_ or copy the code from the `picozero.py`_ file and save it on your main computer.
+
+.. _GitHub repository: https://github.com/RaspberryPiFoundation/picozero
+.. _picozero.py: https://raw.githubusercontent.com/RaspberryPiFoundation/picozero/master/picozero/picozero.py?token=GHSAT0AAAAAABRLTKWZDBSYBE54NJ7AIZ6MYSENI2A
+
+In Thonny, navigate to the cloned directory or location you save the file to find the ``picozero.py`` file.
+
+.. image:: images/thonny-navigate-downloads.jpg
+
+Right click on the file and select the **Upload to /** option and you should see a copy of the ``picozero.py`` file on Raspberry Pi Pico.
+
+.. image:: images/thonny-upload-files.jpg
+.. image:: images/thonny-copy-picozero.jpg
+
+Write a program to control the onboard LED
+------------------------------------------
+
+The following code will blink the onboard LED at a frequency of once per second.::
+
+    from picozero import pico_led
+    from time import sleep
+
+    while True:
+        pico_led.on()
+        sleep(0.5)
+        pico_led.off()
+        sleep(0.5)
+
+Run a program on your computer
+------------------------------
+
+You can choose to run the program from your computer.
+
+Click on the **Run current script button**.
+
+.. image:: images/run-current-script.jpg
+
+Choose to save the script on **This computer** and provide a filename.
+
+.. image:: images/save-this-computer.png
+
+Run a program on Raspberry Pi Pico
+----------------------------------
+
+You can choose to run the program from Raspberry Pi Pico.
+
+Click on the **Run current script button**.
+
+.. image:: images/run-current-script.jpg
+
+Choose to save the script on **Raspberry Pi Pico** and provide a filename.
 
-How to write your first program which flashes the onboard LED
+.. image:: images/save-this-raspberry-pi-pico.png
 
-How to run your program?
+If you call the file ``main.py`` it will run automatically when the Pico is powered.