1 /*
2  * This file is part of the MicroPython project, http://micropython.org/
3  *
4  * The MIT License (MIT)
5  *
6  * Copyright (c) 2013, 2014 Damien P. George
7  *
8  * Permission is hereby granted, free of charge, to any person obtaining a copy
9  * of this software and associated documentation files (the "Software"), to deal
10  * in the Software without restriction, including without limitation the rights
11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12  * copies of the Software, and to permit persons to whom the Software is
13  * furnished to do so, subject to the following conditions:
14  *
15  * The above copyright notice and this permission notice shall be included in
16  * all copies or substantial portions of the Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24  * THE SOFTWARE.
25  */
26 
27 #include "py/builtin.h"
28 
29 const char teensy_help_text[] =
30     "Welcome to MicroPython!\n"
31     "\n"
32     "For online help please visit http://micropython.org/help/.\n"
33     "\n"
34     "Quick overview of commands for the board:\n"
35     "  pyb.info()    -- print some general information\n"
36     "  pyb.gc()      -- run the garbage collector\n"
37     "  pyb.delay(n)  -- wait for n milliseconds\n"
38     "  pyb.Switch()  -- create a switch object\n"
39     "                   Switch methods: (), callback(f)\n"
40     "  pyb.LED(n)    -- create an LED object for LED n (n=1,2,3,4)\n"
41     "                   LED methods: on(), off(), toggle(), intensity(<n>)\n"
42     "  pyb.Pin(pin)  -- get a pin, eg pyb.Pin('X1')\n"
43     "  pyb.Pin(pin, m, [p]) -- get a pin and configure it for IO mode m, pull mode p\n"
44     "                   Pin methods: init(..), value([v]), high(), low()\n"
45     "  pyb.ExtInt(pin, m, p, callback) -- create an external interrupt object\n"
46     "  pyb.ADC(pin)  -- make an analog object from a pin\n"
47     "                   ADC methods: read(), read_timed(buf, freq)\n"
48     "  pyb.DAC(port) -- make a DAC object\n"
49     "                   DAC methods: triangle(freq), write(n), write_timed(buf, freq)\n"
50     "  pyb.RTC()     -- make an RTC object; methods: datetime([val])\n"
51     "  pyb.rng()     -- get a 30-bit hardware random number\n"
52     "  pyb.Servo(n)  -- create Servo object for servo n (n=1,2,3,4)\n"
53     "                   Servo methods: calibration(..), angle([x, [t]]), speed([x, [t]])\n"
54     "  pyb.Accel()   -- create an Accelerometer object\n"
55     "                   Accelerometer methods: x(), y(), z(), tilt(), filtered_xyz()\n"
56     "\n"
57     "Pins are numbered X1-X12, X17-X22, Y1-Y12, or by their MCU name\n"
58     "Pin IO modes are: pyb.Pin.IN, pyb.Pin.OUT_PP, pyb.Pin.OUT_OD\n"
59     "Pin pull modes are: pyb.Pin.PULL_NONE, pyb.Pin.PULL_UP, pyb.Pin.PULL_DOWN\n"
60     "Additional serial bus objects: pyb.I2C(n), pyb.SPI(n), pyb.UART(n)\n"
61     "\n"
62     "Control commands:\n"
63     "  CTRL-A        -- on a blank line, enter raw REPL mode\n"
64     "  CTRL-B        -- on a blank line, enter normal REPL mode\n"
65     "  CTRL-C        -- interrupt a running program\n"
66     "  CTRL-D        -- on a blank line, do a soft reset of the board\n"
67     "\n"
68     "For further help on a specific object, type help(obj)\n"
69 ;
70