Skip to content
Snippets Groups Projects
Commit 5ea69859 authored by Damien George's avatar Damien George
Browse files

stmhal: Update help text.

parent 350cb6bf
No related branches found
No related tags found
No related merge requests found
...@@ -11,30 +11,33 @@ STATIC const char *help_text = ...@@ -11,30 +11,33 @@ STATIC const char *help_text =
"\n" "\n"
"For online help please visit http://micropython.org/help/.\n" "For online help please visit http://micropython.org/help/.\n"
"\n" "\n"
"Specific commands for the board:\n" "Quick overview of commands for the board:\n"
" pyb.info() -- print some general information\n" " pyb.info() -- print some general information\n"
" pyb.gc() -- run the garbage collector\n" " pyb.gc() -- run the garbage collector\n"
" pyb.repl_info(val) -- enable/disable printing of info after each command\n"
" pyb.delay(n) -- wait for n milliseconds\n" " pyb.delay(n) -- wait for n milliseconds\n"
" pyb.udelay(n) -- wait for n microseconds\n" " pyb.Switch() -- create a switch object\n"
" pyb.switch() -- return True/False if switch pressed or not\n" " Switch methods: (), callback(f)\n"
" pyb.switch(f) -- call the given function when the switch is pressed\n" " pyb.LED(n) -- create an LED object for LED n (n=1,2,3,4)\n"
" pyb.Led(n) -- create Led object for LED n (n=1,2,3,4)\n" " LED methods: on(), off(), toggle(), intensity(<n>)\n"
" Led methods: on(), off(), toggle(), intensity(<n>)\n" " pyb.Pin(pin) -- get a pin, eg pyb.Pin('X1')\n"
" pyb.Pin(pin) -- get a pin\n"
" pyb.Pin(pin, m, [p]) -- get a pin and configure it for IO mode m, pull mode p\n" " pyb.Pin(pin, m, [p]) -- get a pin and configure it for IO mode m, pull mode p\n"
" Pin methods: value([v]), high(), low()\n" " Pin methods: init(..), value([v]), high(), low()\n"
" pyb.ExtInt(pin, m, p, callback) -- create an external interrupt object\n"
" pyb.ADC(pin) -- make an analog object from a pin\n"
" ADC methods: read(), read_timed(buf, freq)\n"
" pyb.DAC(port) -- make a DAC object\n"
" DAC methods: triangle(freq), write(n), write_timed(buf, freq)\n"
" pyb.RTC() -- make an RTC object; methods: datetime([val])\n"
" pyb.rng() -- get a 30-bit hardware random number\n"
" pyb.Servo(n) -- create Servo object for servo n (n=1,2,3,4)\n" " pyb.Servo(n) -- create Servo object for servo n (n=1,2,3,4)\n"
" Servo methods: calibrate(...), pulse_width([p]), angle([x, [t]]), speed([x, [t]])\n" " Servo methods: calibration(..), angle([x, [t]]), speed([x, [t]])\n"
" pyb.Accel() -- create an Accelerometer object\n" " pyb.Accel() -- create an Accelerometer object\n"
" Accelerometer methods: x(), y(), z(), tilt(), filtered_xyz()\n" " Accelerometer methods: x(), y(), z(), tilt(), filtered_xyz()\n"
" pyb.rng() -- get a 30-bit hardware random number\n"
" pyb.ADC(port) -- make an analog port object\n"
" ADC methods: read()\n"
"\n" "\n"
"Ports are numbered X1-X12, X17-X22, Y1-Y12, or by their MCU name\n" "Pins are numbered X1-X12, X17-X22, Y1-Y12, or by their MCU name\n"
"Port IO modes are: pyb.Pin.IN, pyb.Pin.OUT_PP, pyb.Pin.OUT_OD\n" "Pin IO modes are: pyb.Pin.IN, pyb.Pin.OUT_PP, pyb.Pin.OUT_OD\n"
"Port pull modes are: pyb.Pin.PULL_NONE, pyb.Pin.PULL_UP, pyb.Pin.PULL_DOWN\n" "Pin pull modes are: pyb.Pin.PULL_NONE, pyb.Pin.PULL_UP, pyb.Pin.PULL_DOWN\n"
"Additional serial bus objects: pyb.I2C(n), pyb.SPI(n), pyb.UART(n)\n"
"\n" "\n"
"Control commands:\n" "Control commands:\n"
" CTRL-A -- on a blank line, enter raw REPL mode\n" " CTRL-A -- on a blank line, enter raw REPL mode\n"
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment