Skip to content

Commit 1afb590

Browse files
committed
Update README.md
1 parent 7741ca0 commit 1afb590

File tree

1 file changed

+23
-24
lines changed

1 file changed

+23
-24
lines changed

README.md

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,57 @@
11
MicroPython-Examples
22
====================
33

4-
5-
####NOTE: THIS REPOSITORY HAS RECENTLY BEEN UPDATED AND THE CHANGES HAVEN'T BEEN UPDATED IN THIS FILE YET
6-
7-
8-
94
This repo features examples for MicroPython similar to Arduino.
105

116
###00.Basics
127

13-
__BareMinimum__
14-
A template that serves as a starting point
8+
__boot.py__
9+
Sample boot file which points to 'helloWorld.py' to run after booting. The examples in this repo will not include copies of the boot file. Please edit and include boot.py accordingly.
1510

16-
__HelloWorld__
11+
__helloWorld.py__
1712
Turns on LED 4 (the blue LED).
1813

1914
__REPL__
2015
REPL stands for Read-Eval-Print-Loop.
2116
Very important and highly useful feature that allows easy debugging and quick learning.
22-
All examples could be tested on the board without having to manually upload every time.
23-
24-
__RunForever__
25-
A simple while True loop that mimicks Arduino's loop() at a very simple level
17+
All examples can be tested on the board without having to manually upload every time.
2618

2719
====================
2820

2921
###01.LEDs
3022

31-
__Blink__
23+
__blink__
3224
Replicates Arduino's Blink sketch exactly (uses .on() and .off() and loops)
3325

34-
__BlinkWithoutDelay__
26+
__blinkWithoutDelay__
3527
Replicates Arduino's BlinkWithoutDelay sketch (uses .toggle() and .millis())
3628

37-
__BlinkWithToggle__
29+
__blinkToggle__
3830
Same as Blink, but uses .toggle()
3931

40-
__Fade__
32+
__fade__
4133
Similar to Arduino's Fade sketch
4234

43-
__Heartbeat__
35+
__heartbeat__
4436
Something more interesting that simple blinks
4537

46-
__HeartbeatFade__
38+
__heartbeatFade__
4739
Similar to previous 'Heartbeat' script, but fades the light in and out instead of just switching on and off
4840

4941
====================
5042

5143
###02.Inputs
5244

53-
__SimpleButton__
45+
__button__
5446
Pull down button that toggles an LED
5547

56-
__Potentiometer__
48+
__potentiometer__
5749
Simple analog input that controls an LED's intensity
5850

59-
__SwitchObject__
51+
__switchObject__
6052
Simple demo of the Switch object that can control the inbuilt USR button on the pyboard
6153

62-
__SwitchCallback__
54+
__switchCallback__
6355
Example of the Switch.callback function (uses interrupts)
6456

6557
====================
@@ -73,11 +65,11 @@ Example of using on of the pins to control an output (LED, motor, buzzer, relay,
7365

7466
###04.Accelerometer
7567

76-
__AccelerometerControlLED__
68+
__accelerometerControlLED__
7769
Controls blink speed of an LED using the accelerometer's value along the X axis
7870
This script also features a custom remap() function that remaps a value to different bounds/range
7971

80-
__AccelerometerTest__
72+
__accelerometer__
8173
Prints the x,y,z values of the accelerometer every second (REPL required)
8274

8375
====================
@@ -92,6 +84,13 @@ Generates a random number roughly between -90 and 90, and sets it as the servo's
9284

9385
====================
9486

87+
###06.Clock
88+
89+
__clock__
90+
Uses the RTC (independent Real Time Clock) in the pyboard. Prints the time and date with delay of 100 microseconds. Start time is set with variables.
91+
92+
====================
93+
9594
Contributions include code from:
9695
[Mithru Vigneshwara](https://github.com/mithru/MicroPython-Examples/)
9796
[Dave Hylands](https://github.com/dhylands/upy-examples/)

0 commit comments

Comments
 (0)