pytropicsquare

Documentation:

  • Installation
    • CPython
    • MicroPython / ESP32
      • Option 1: Install from a release with mip
      • Option 2: Upload from a source checkout with mpremote
  • API Reference
    • Overview
    • Quick Reference
      • Main Classes
      • Transport Classes
    • Detailed Documentation
      • TropicSquare Core Class
        • TropicSquare
          • TropicSquare.__new__()
          • TropicSquare.__init__()
          • TropicSquare.certificate
          • TropicSquare.public_key
          • TropicSquare.chip_id
          • TropicSquare.riscv_fw_version
          • TropicSquare.spect_fw_version
          • TropicSquare.fw_bank
          • TropicSquare.start_secure_session()
          • TropicSquare.abort_secure_session()
          • TropicSquare.reboot()
          • TropicSquare.sleep()
          • TropicSquare.get_log()
          • TropicSquare.ping()
          • TropicSquare.random()
          • TropicSquare.r_config_read()
          • TropicSquare.i_config_read()
          • TropicSquare.r_config_write()
          • TropicSquare.i_config_write()
          • TropicSquare.r_config_erase()
          • TropicSquare.mem_data_read()
          • TropicSquare.mem_data_write()
          • TropicSquare.mem_data_erase()
          • TropicSquare.ecc_key_generate()
          • TropicSquare.ecc_key_store()
          • TropicSquare.ecc_key_read()
          • TropicSquare.ecc_key_erase()
          • TropicSquare.ecdsa_sign()
          • TropicSquare.eddsa_sign()
          • TropicSquare.mcounter_init()
          • TropicSquare.mcounter_update()
          • TropicSquare.mcounter_get()
          • TropicSquare.mac_and_destroy()
          • TropicSquare.pairing_key_read()
          • TropicSquare.pairing_key_write()
          • TropicSquare.pairing_key_invalidate()
        • Platform-Specific Implementations
        • See Also
      • L2 Protocol Layer
        • L2Protocol
          • L2Protocol.__init__()
          • L2Protocol.get_info_req()
          • L2Protocol.handshake_req()
          • L2Protocol.get_log()
          • L2Protocol.encrypted_command()
          • L2Protocol.encrypted_session_abt()
          • L2Protocol.sleep_req()
          • L2Protocol.startup_req()
        • Protocol Overview
        • Session Management
        • See Also
      • Transport Layer
        • Available Transports
        • Transport Selection Guide
        • Detailed Documentation
          • L1Transport Base Class
          • SPI Transport
          • SPIDev Transport
          • FTDI MPSSE Transport
          • UART Transport
          • Network-SPI Transport
          • TCP Transport
      • Platform Ports
        • Available Ports
        • Platform Comparison
        • Detailed Documentation
          • CPython Port
          • MicroPython Port
      • Chip Information
        • Available Classes
        • Chip ID Structure
        • Detailed Documentation
          • Chip ID
          • Serial Number
      • Configuration Management
        • Configuration Types
        • Configuration Classes
        • User Access Policy (UAP)
          • Base Configuration Classes
          • System Configuration
          • User Access Policy (UAP)
        • See Also
      • Cryptographic Operations
        • ECC Support
        • Available Classes
        • Detailed Documentation
          • ECC Operations
          • Signature Classes
        • See Also
      • Constants and Enumerations
        • Constant Categories
        • Usage
        • Detailed Documentation
          • Protocol Constants
          • Status and Result Codes
          • ECC Constants
          • Get Info Request Constants
          • Pairing Keys Constants
          • Configuration Register Constants
      • Utilities and Error Handling
        • Available Utilities
        • CRC Utilities
        • Error Mapping
        • Exception Classes
        • Detailed Documentation
          • CRC Utilities
          • Error Mapping
          • Exception Classes
  • Testing
    • Test Reports
      • Coverage Target
    • Running Tests Locally
      • Prerequisites
      • Running the Full Test Suite
      • Running Specific Tests
    • Continuous Integration
      • GitHub Actions
    • Test Organization
      • Test Structure
      • Testing Strategy
    • Writing Tests
      • Test Naming
      • Example Test
      • Using Fixtures
    • Coverage Guidelines
      • Target Coverage
      • What to Test
    • Troubleshooting
      • Common Issues
    • Contributing
  • Test Results
  • Code Coverage
  • Examples
    • PyTropicSquare Examples
      • Setup
      • Quick Start
      • Transport Configuration
        • Option 1: Network SPI Bridge (Default)
        • Option 2: Direct SPI (MicroPython Only)
        • Option 3: UART SPI Bridge
      • Examples by Category
        • Getting Started (No crypto knowledge required)
        • Cryptographic Operations
        • Data Storage
        • Configuration Management - Advanced
        • Platform-Specific Examples
        • Advanced Features
      • Platform Compatibility
        • Platform-Specific Limitations
      • Pairing Keys
      • Error Handling Pattern
      • Learning Path
        • Beginner Track
        • Cryptography Track
        • Data Storage Track
        • Advanced Track
      • Hardware Requirements
        • Minimum Setup
        • Common Hardware Configurations
      • Troubleshooting
        • ModuleNotFoundError: No module named ‘tropicsquare’
        • Connection timeout or CRC errors
        • Handshake errors
        • ESP32 sys.argv not working
      • Support
      • Contributing Examples
      • License
pytropicsquare
  • Search

© Copyright 2025, Petr Kracik.

Built with Sphinx using a theme provided by Read the Docs.