Skip to content

docs: Branch with the V2 documentation #743

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

Closed
wants to merge 11 commits into from
Closed

docs: Branch with the V2 documentation #743

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
cd5a13e
docs: Update the docs to include the V2 API (#692)
microbit-mark Dec 3, 2020
309a585
Docs: update for V2 neopixel module (#694)
microbit-mark Dec 18, 2020
933c34e
Docs: Speaker update and play() pin arguments (#695)
microbit-mark Dec 18, 2020
00b59d3
V2 docs: Remove is_on() from speaker. (#696)
microbit-carlos Dec 21, 2020
c024951
V2 docs: Add pin set_touch_mode() (#701)
microbit-mark Jan 8, 2021
a38b3e2
docs: Update Memory layout, Partial Flashing, Building for V2, BLE (#…
microbit-sam Feb 3, 2021
0dcd7a6
docs: Include V2 features in tutorials (#709)
microbit-mark Feb 24, 2021
e11a2c5
docs: dev guide updates (#711)
microbit-mark Mar 16, 2021
9b690a7
docs: Indicate pin_speaker is only for PWM (#715)
microbit-mark Apr 7, 2021
790f387
docs: Fix typo in neopixel, mumber -> number (#727)
microbit-matt-hillsdon Sep 23, 2021
45c3f4d
docs: Add V2 microbit.set_volume() info. (#742)
microbit-carlos Apr 25, 2022
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
Prev Previous commit
Next Next commit
V2 docs: Remove is_on() from speaker. (#696)
  • Loading branch information
@microbit-carlos
microbit-carlos committed Apr 29, 2022
commit 00b59d373afec095e2bf33760b9408d3f3b535e3
9 changes: 2 additions & 7 deletions docs/speaker.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,25 +22,20 @@ Functions

.. py:function:: off()

Use off() to turn off the speaker. This does not disable sound output, so
you will still hear sound on Pin 0 if you have headphones or a speaker
connected to that pin.
Use ``off()`` to turn off the speaker. This does not disable sound output
to an edge connector pin.

.. py:function:: on()

Use ``on()`` to turn on the speaker.

.. py:function:: is_on()

Returns ``True`` if the speaker is on, otherwise returns ``False``.

Example
=======

An example that runs through some of the functions of the speaker API. ::

from microbit import *
import audio

# Check that the speaker is on
print(speaker.is_on())
Expand Down