MicroPython documentation and references

• Quick reference for the ESP8266
  • Installing MicroPython
  • General board control
  • Networking
  • Delay and timing
  • Timers
  • Pins and GPIO
  • PWM (pulse width modulation)
  • ADC (analog to digital conversion)
  • Software SPI bus
  • Hardware SPI bus
  • I2C bus
  • Real time clock (RTC)
  • Deep-sleep mode
  • OneWire driver
  • NeoPixel driver
  • APA102 driver
  • DHT driver
  • WebREPL (web browser interactive prompt)
• General information about the ESP8266 port
  • Multitude of boards
  • Technical specifications and SoC datasheets
  • Scarcity of runtime resources
  • Boot process
  • Known Issues
    • Real-time clock
    • Sockets and WiFi buffers overflow
    • SSL/TLS limitations
• MicroPython tutorial for ESP8266
  • 1. Getting started with MicroPython on the ESP8266
    • 1.1. Requirements
    • 1.2. Powering the board
    • 1.3. Getting the firmware
    • 1.4. Deploying the firmware
    • 1.5. Serial prompt
    • 1.6. WiFi
    • 1.7. Troubleshooting installation problems
  • 2. Getting a MicroPython REPL prompt
    • 2.1. REPL over the serial port
    • 2.2. WebREPL - a prompt over WiFi
    • 2.3. Using the REPL
      • 2.3.1. Line editing
      • 2.3.2. Input history
      • 2.3.3. Tab completion
      • 2.3.4. Line continuation and auto-indent
      • 2.3.5. Paste mode
      • 2.3.6. Other control commands
  • 3. The internal filesystem
    • 3.1. Creating and reading files
    • 3.2. Listing file and more
    • 3.3. Start up scripts
    • 3.4. Accessing the filesystem via WebREPL
  • 4. Network basics
    • 4.1. Configuration of the WiFi
    • 4.2. Sockets
  • 5. Network - TCP sockets
    • 5.1. Star Wars Asciimation
    • 5.2. HTTP GET request
    • 5.3. Simple HTTP server
  • 6. GPIO Pins
    • 6.1. External interrupts
  • 7. Pulse Width Modulation
    • 7.1. Fading an LED
    • 7.2. Control a hobby servo
  • 8. Analog to Digital Conversion
  • 9. Power control
    • 9.1. Changing the CPU frequency
    • 9.2. Deep-sleep mode
  • 10. Controlling 1-wire devices
  • 11. Controlling NeoPixels
  • 12. Temperature and Humidity
  • 13. Next steps
• 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
    • math – mathematical functions
      • Functions
      • Constants
    • sys – system specific functions
      • Functions
      • Constants
    • ubinascii – binary/ASCII conversions
      • Functions
    • ucollections – collection and container types
      • Classes
    • uerrno – system error codes
      • Constants
    • uhashlib – hashing algorithms
      • Constructors
      • Methods
    • uheapq – heap queue algorithm
      • Functions
    • uio – input/output streams
      • Conceptual hierarchy
      • Functions
      • Classes
    • ujson – JSON encoding and decoding
      • Functions
    • uos – basic “operating system” services
      • General functions
      • Filesystem access
      • Terminal redirection and duplication
      • Filesystem mounting
      • Block devices
    • 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
    • ustruct – pack and unpack primitive data types
      • Functions
    • utime – time related functions
      • Functions
    • uzlib – zlib decompression
      • 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 Signal – control and sense external I/O devices
          • Constructors
          • Methods
        • class UART – duplex serial communication bus
          • Constructors
          • Methods
        • 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 WDT – watchdog timer
          • Constructors
          • Methods
    • micropython – access and control MicroPython internals
      • Functions
    • network — network configuration
      • Common network adapter interface
      • Functions
      • class WLAN
        • Constructors
        • Methods
    • 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 ESP8266
    • esp — functions related to the ESP8266
      • 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
  • Distribution packages, package management, and deploying applications
    • Overview
    • Distribution packages
    • upip package manager
    • Cross-installing packages
    • Cross-installing packages with freezing
    • Creating distribution packages
    • Application resources
    • References
• 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
      • 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__ method does not exist.
    • 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
    • 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
      • 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
    • builtins
      • Second argument to next() is not 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