MicroPython documentation and references

• Quick reference for the WiPy
  • General board control (including sleep modes)
  • Pins and GPIO
  • Timers
  • PWM (pulse width modulation)
  • ADC (analog to digital conversion)
  • UART (serial bus)
  • SPI bus
  • I2C bus
  • Watchdog timer (WDT)
  • Real time clock (RTC)
  • SD card
  • WLAN (WiFi)
  • Telnet and FTP server
  • Heart beat LED
• General information about the WiPy
  • No floating point support
  • Before applying power
  • WLAN default behaviour
  • Telnet REPL
  • Local file system and FTP access
  • FileZilla settings
  • Upgrading the firmware Over The Air
  • Boot modes and safe boot
  • The heartbeat LED
  • Details on sleep modes
  • Additional details for machine.Pin
  • Additional details for machine.I2C
  • Known issues
    • Incompatible way to create SSL sockets
    • Incompatibilities in uhashlib module
    • Unrelated function in machine module
    • Adhoc way to control telnet/FTP server via network module
    • Adhoc VFS-like support
• WiPy tutorials and examples
  • 1. Introduction to the WiPy
    • 1.1. Caring for your WiPy and expansion board
    • 1.2. Plugging into the expansion board and powering on
    • 1.3. Expansion board hardware guide
    • 1.4. Powering by an external power source
    • 1.5. Performing firmware upgrades
  • 2. Getting a MicroPython REPL prompt
    • 2.1. Windows
    • 2.2. Mac OS X
    • 2.3. Linux
    • 2.4. Using the REPL prompt
    • 2.5. Resetting the board
  • 3. Getting started with Blynk and the WiPy
  • 4. WLAN step by step
    • 4.1. Connecting to your home router
    • 4.2. Assigning a static IP address when booting
  • 5. Hardware timers
    • 5.1. Additional constants for Timer class
  • 6. Reset and boot modes
    • 6.1. Safe boot
    • 6.2. Factory reset the filesystem
• MicroPython libraries
  • Python standard libraries and micro-libraries
    • Builtin functions and exceptions
      • Functions and types
      • Exceptions
    • array – arrays of numeric data
      • Classes
    • gc – control the garbage collector
      • Functions
    • sys – system specific functions
      • Functions
      • Constants
    • ubinascii – binary/ASCII conversions
      • Functions
    • ujson – JSON encoding and decoding
      • Functions
    • uos – basic “operating system” services
      • Functions
    • ure – simple regular expressions
      • Functions
      • Regex objects
      • Match objects
    • uselect – wait for events on a set of streams
      • Functions
      • class Poll
        • Methods
    • usocket – socket module
      • Socket address format(s)
      • Functions
      • Constants
        • class socket
      • Methods
    • ussl – SSL/TLS module
      • Functions
      • Exceptions
      • Constants
    • utime – time related functions
      • Functions
  • MicroPython-specific libraries
    • btree – simple BTree database
      • Functions
      • Methods
      • Constants
    • framebuf — Frame buffer manipulation
      • class FrameBuffer
      • Constructors
      • Drawing primitive shapes
      • Drawing text
      • Other methods
      • Constants
    • machine — functions related to the hardware
      • Reset related functions
      • Interrupt related functions
      • Power related functions
      • Miscellaneous functions
      • Constants
      • Classes
        • class Pin – control I/O pins
          • Constructors
          • Methods
          • Constants
        • class UART – duplex serial communication bus
          • Constructors
          • Methods
          • Constants
        • class SPI – a Serial Peripheral Interface bus protocol (master side)
          • Constructors
          • Methods
          • Constants
        • class I2C – a two-wire serial protocol
          • Constructors
          • General Methods
          • Primitive I2C operations
          • Standard bus operations
          • Memory operations
        • class RTC – real time clock
          • Constructors
          • Methods
          • Constants
        • class Timer – control hardware timers
          • Constructors
          • Methods
          • Constants
        • class TimerChannel — setup a channel for a timer
          • Methods
        • class WDT – watchdog timer
          • Constructors
          • Methods
        • class ADC – analog to digital conversion
          • Constructors
          • Methods
        • class ADCChannel — read analog values from internal or external sources
        • class SD – secure digital memory card
          • Constructors
          • Methods
    • micropython – access and control MicroPython internals
      • Functions
    • network — network configuration
      • Common network adapter interface
      • class WLAN
        • Constructors
        • Methods
        • Constants
    • uctypes – access binary data in a structured way
      • Defining structure layout
      • Module contents
      • Structure descriptors and instantiating structure objects
      • Structure objects
      • Limitations
  • Libraries specific to the WiPy
    • wipy – WiPy specific features
      • Functions
• The MicroPython language
  • Glossary
  • The MicroPython Interactive Interpreter Mode (aka REPL)
    • Auto-indent
    • Auto-completion
    • Interrupting a running program
    • Paste Mode
    • Soft Reset
    • The special variable _ (underscore)
    • Raw Mode
  • Writing interrupt handlers
    • Tips and recommended practices
    • MicroPython Issues
      • The emergency exception buffer
      • Simplicity
      • Communication between an ISR and the main program
      • The use of object methods as callbacks
      • Creation of Python objects
      • Use of Python objects
      • Overcoming the float limitation
      • Using micropython.schedule
    • Exceptions
    • General Issues
      • Interrupt Handler Design
      • Reentrancy
      • Critical Sections
      • Interrupts and the REPL
  • Maximising MicroPython Speed
    • Designing for speed
      • Algorithms
      • RAM Allocation
      • Buffers
      • Floating Point
      • Arrays
    • Identifying the slowest section of code
    • MicroPython code improvements
      • The const() declaration
      • Caching object references
      • Controlling garbage collection
    • The Native code emitter
    • The Viper code emitter
    • Accessing hardware directly
  • MicroPython on Microcontrollers
    • Flash Memory
    • RAM
      • Compilation Phase
      • Execution Phase
    • The Heap
      • Fragmentation
      • Reporting
      • Control of Garbage Collection
    • String Operations
    • Postscript
      • Footnote: gc.collect() return value
• MicroPython differences from CPython
  • Syntax
    • Spaces
      • uPy requires spaces between literal numbers and keywords, CPy doesn’t
    • Unicode
      • Unicode name escapes are not implemented
  • Core Language
    • Classes
      • Special method __del__ not implemented for user-defined classes
      • Method Resolution Order (MRO) is not compliant with CPython
      • When inheriting from multiple classes super() only calls one class
      • Calling super() getter property in subclass will return a property object, not the value
    • Functions
      • Error messages for methods may display unexpected argument counts
      • Unpacking function arguments in non-last position isn’t detected as an error
      • User-defined attributes for functions are not supported
    • Generator
      • Context manager __exit__() not called in a generator which does not run to completion
    • Runtime
      • Local variables aren’t included in locals() result
      • Code running in eval() function doesn’t have access to local variables
    • import
      • __path__ attribute of a package has a different type (single string instead of list of strings) in MicroPython
      • Failed to load modules are still registered as loaded
      • MicroPython does’t support namespace packages split across filesystem.
  • Builtin Types
    • Exception
      • Exception chaining not implemented
      • User-defined attributes for builtin exceptions are not supported
      • Exception in while loop condition may have unexpected line number
      • Exception.__init__ raises TypeError if overridden and called by subclass
    • bytearray
      • Array slice assignment with unsupported RHS
    • bytes
      • bytes() with keywords not implemented
      • Bytes subscription with step != 1 not implemented
    • float
      • uPy and CPython outputs formats may differ
    • int
      • No int conversion for int-derived types available
      • Incorrect error message when passing float into to_bytes
    • list
      • List delete with step != 1 not implemented
      • List slice-store with non-iterable on RHS is not implemented
      • List store with step != 1 not implemented
    • str
      • UnicodeDecodeError not raised when expected
      • Start/end indices such as str.endswith(s, start) not implemented
      • Attributes/subscr not implemented
      • str(…) with keywords not implemented
      • str.ljust() and str.rjust() not implemented
      • None as first argument for rsplit such as str.rsplit(None, n) not implemented
      • Instance of a subclass of str cannot be compared for equality with an instance of a str
      • Subscript with step != 1 is not yet implemented
    • tuple
      • Tuple load with step != 1 not implemented
  • Modules
    • array
      • Looking for integer not implemented
      • Array deletion not implemented
      • Subscript with step != 1 is not yet implemented
    • deque
      • Deque not implemented
    • json
      • JSON module does not throw exception when object is not serialisable
    • struct
      • Struct pack with too few args, not checked by uPy
      • Struct pack with too many args, not checked by uPy
    • sys
      • Overriding sys.stdin, sys.stdout and sys.stderr not possible
• MicroPython license information