Skip to content

Commit 5ea6985

Browse files
dpgeorgedpgeorge
committed
stmhal: Update help text.
1 parent 350cb6b commit 5ea6985

1 file changed

Lines changed: 29 additions & 26 deletions

File tree

‎stmhal/help.c‎

Lines changed: 29 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -11,36 +11,39 @@ STATIC const char *help_text =
1111
"\n"
1212
"For online help please visit http://micropython.org/help/.\n"
1313
"\n"
14-
"Specific commands for the board:\n"
15-
" pyb.info() -- print some general information\n"
16-
" pyb.gc() -- run the garbage collector\n"
17-
" pyb.repl_info(val) -- enable/disable printing of info after each command\n"
18-
" pyb.delay(n) -- wait for n milliseconds\n"
19-
" pyb.udelay(n) -- wait for n microseconds\n"
20-
" pyb.switch() -- return True/False if switch pressed or not\n"
21-
" pyb.switch(f) -- call the given function when the switch is pressed\n"
22-
" pyb.Led(n) -- create Led object for LED n (n=1,2,3,4)\n"
23-
" Led methods: on(), off(), toggle(), intensity(<n>)\n"
24-
" pyb.Pin(pin) -- get a pin\n"
14+
"Quick overview of commands for the board:\n"
15+
" pyb.info() -- print some general information\n"
16+
" pyb.gc() -- run the garbage collector\n"
17+
" pyb.delay(n) -- wait for n milliseconds\n"
18+
" pyb.Switch() -- create a switch object\n"
19+
" Switch methods: (), callback(f)\n"
20+
" pyb.LED(n) -- create an LED object for LED n (n=1,2,3,4)\n"
21+
" LED methods: on(), off(), toggle(), intensity(<n>)\n"
22+
" pyb.Pin(pin) -- get a pin, eg pyb.Pin('X1')\n"
2523
" pyb.Pin(pin, m, [p]) -- get a pin and configure it for IO mode m, pull mode p\n"
26-
" Pin methods: value([v]), high(), low()\n"
27-
" pyb.Servo(n) -- create Servo object for servo n (n=1,2,3,4)\n"
28-
" Servo methods: calibrate(...), pulse_width([p]), angle([x, [t]]), speed([x, [t]])\n"
29-
" pyb.Accel() -- create an Accelerometer object\n"
30-
" Accelerometer methods: x(), y(), z(), tilt(), filtered_xyz()\n"
31-
" pyb.rng() -- get a 30-bit hardware random number\n"
32-
" pyb.ADC(port) -- make an analog port object\n"
33-
" ADC methods: read()\n"
24+
" Pin methods: init(..), value([v]), high(), low()\n"
25+
" pyb.ExtInt(pin, m, p, callback) -- create an external interrupt object\n"
26+
" pyb.ADC(pin) -- make an analog object from a pin\n"
27+
" ADC methods: read(), read_timed(buf, freq)\n"
28+
" pyb.DAC(port) -- make a DAC object\n"
29+
" DAC methods: triangle(freq), write(n), write_timed(buf, freq)\n"
30+
" pyb.RTC() -- make an RTC object; methods: datetime([val])\n"
31+
" pyb.rng() -- get a 30-bit hardware random number\n"
32+
" pyb.Servo(n) -- create Servo object for servo n (n=1,2,3,4)\n"
33+
" Servo methods: calibration(..), angle([x, [t]]), speed([x, [t]])\n"
34+
" pyb.Accel() -- create an Accelerometer object\n"
35+
" Accelerometer methods: x(), y(), z(), tilt(), filtered_xyz()\n"
3436
"\n"
35-
"Ports are numbered X1-X12, X17-X22, Y1-Y12, or by their MCU name\n"
36-
"Port IO modes are: pyb.Pin.IN, pyb.Pin.OUT_PP, pyb.Pin.OUT_OD\n"
37-
"Port pull modes are: pyb.Pin.PULL_NONE, pyb.Pin.PULL_UP, pyb.Pin.PULL_DOWN\n"
37+
"Pins are numbered X1-X12, X17-X22, Y1-Y12, or by their MCU name\n"
38+
"Pin IO modes are: pyb.Pin.IN, pyb.Pin.OUT_PP, pyb.Pin.OUT_OD\n"
39+
"Pin pull modes are: pyb.Pin.PULL_NONE, pyb.Pin.PULL_UP, pyb.Pin.PULL_DOWN\n"
40+
"Additional serial bus objects: pyb.I2C(n), pyb.SPI(n), pyb.UART(n)\n"
3841
"\n"
3942
"Control commands:\n"
40-
" CTRL-A -- on a blank line, enter raw REPL mode\n"
41-
" CTRL-B -- on a blank line, enter normal REPL mode\n"
42-
" CTRL-C -- interrupt a running program\n"
43-
" CTRL-D -- on a blank line, do a soft reset of the board\n"
43+
" CTRL-A -- on a blank line, enter raw REPL mode\n"
44+
" CTRL-B -- on a blank line, enter normal REPL mode\n"
45+
" CTRL-C -- interrupt a running program\n"
46+
" CTRL-D -- on a blank line, do a soft reset of the board\n"
4447
"\n"
4548
"For further help on a specific object, type help(obj)\n"
4649
;

0 commit comments

Comments
 (0)