diff options
| author | Daniel Campora <daniel@wipy.io> | 2015-06-11 15:53:31 +0200 |
|---|---|---|
| committer | Daniel Campora <daniel@wipy.io> | 2015-06-16 15:45:24 +0200 |
| commit | ea2cc2b907c2c82283f7f06c9538008b51051d84 (patch) | |
| tree | 3a865e7794a9f5fa5d1c1e185283b242886b748c /docs/wipy | |
| parent | cdfa11f5503b53824d1c0552ae5fda64422202da (diff) | |
docs: Add more documentation for the CC3200 in the pyb module.
Diffstat (limited to 'docs/wipy')
| -rw-r--r-- | docs/wipy/general.rst | 12 | ||||
| -rw-r--r-- | docs/wipy/quickref.rst | 18 |
2 files changed, 14 insertions, 16 deletions
diff --git a/docs/wipy/general.rst b/docs/wipy/general.rst index 894990619..3aad440ba 100644 --- a/docs/wipy/general.rst +++ b/docs/wipy/general.rst @@ -35,12 +35,12 @@ If you power up normally, or press the reset button, the WiPy will boot into standard mode: the ``boot.py`` file will be executed first, then ``main.py`` will run. -You can override this boot sequence by pulling ``GPIO28`` **up** during reset. -The heart beat LED will flash slowly 3 times to signal that safe boot is being -requested, and then 3 more times quickly to let you know that safe boot is -going to be performed. While safe booting, the WiPy runs the factory firmware -and skips the execution of ``boot.py`` and ``main.py``. This is useful to -recover from any crash situation. +You can override this boot sequence by pulling ``GPIO28`` **up** (connect +it to the 3v3 output pin) during reset. The heart beat LED will flash slowly +3 times to signal that safe boot is being requested, and then 3 more times +quickly to let you know that safe boot is going to be performed. While safe +booting, the WiPy runs the factory firmware and skips the execution of +``boot.py`` and ``main.py``. This is useful to recover from any crash situation. The heart beat LED ------------------ diff --git a/docs/wipy/quickref.rst b/docs/wipy/quickref.rst index 9733a8714..a8e0bdc98 100644 --- a/docs/wipy/quickref.rst +++ b/docs/wipy/quickref.rst @@ -1,6 +1,4 @@ -.. only:: port_wipy - - .. _quickref_: +.. _quickref_: Quick reference for the WiPy ============================ @@ -20,7 +18,7 @@ See :mod:`pyb`. :: pyb.delay(50) # wait 50 milliseconds pyb.millis() # number of milliseconds since boot-up pyb.freq() # get the CPU frequency - pyb.unique_id() # return the 6-byte unique id of the board (it's MAC address) + pyb.unique_id() # return the 6-byte unique id of the board (the WiPy's MAC address) Pins and GPIO ------------- @@ -176,7 +174,7 @@ See :ref:`pyb.SD <pyb.SD>`. :: # SD card pins need special configuration so we pass 'em to the constructor # data pin, data af, clock pin, clock af, cmd pin, cmd af - sd = SD('GPIO15', 8, 'GPIO16', 8, 'GPIO17', 8) + sd = pyb.SD('GPIO15', 8, 'GPIO10', 6, 'GPIO11', 6) sd.enable() WLAN (WiFi) @@ -213,16 +211,16 @@ See ``pyb.Sleep``. :: Sleep.suspend() # everything except for WLAN is powered down (~950uA) # wakes from Pin, RTC or WLAN - Sleep.hibernate() # deepest sleep mode, mcu starts from reset. Wakes from Pin and RTC. + Sleep.hibernate() # deepest sleep mode, MCU starts from reset. Wakes from Pin and RTC. Heart beat LED ------------------------------ +-------------- See :ref:`pyb.HeartBeat <pyb.HeartBeat>`. :: from pyb import HeartBeat - # disable the heart beat indication (you are free to use this led connected to GPIO25) - HeartBeat.disable() + # disable the heart beat indication (you are free to use this LED connected to GPIO25) + HeartBeat().disable() # enable the heart beat again - HeartBeat.enable() + HeartBeat().enable() |