AlpycaDevice SDK Logo
1.0.3
  • Alpyca Device Quick Start
    • Running the Sample with the Conformance Checker
    • Creating Your First Driver
  • Introduction to Alpaca Drivers
    • Alpaca Device and Driver Architecture
    • Sample Driver Organization
    • Asynchronous Operations
    • Handling Exceptions
      • Alpaca Exceptions
      • Python Exceptions
    • Making this sample into your driver
  • Developer Roadmap
    • Logging Support
    • Alpaca Driver Request Flow - Responder Classes
      • Preprocessor
      • GET responder
      • PUT Responder
    • Alpaca Exceptions
      • Run-Time Errors - DriverException
      • Invocations of DriverException
      • Example of DriverException with Normal and Verbose Exceptions
    • Unhandled Exceptions
  • Template/Sample Module Structure
    • Alpaca API Implementation Modules
      • Rotator - Device-Specific Responders
        • API Responder Documentation
          • RotatorMetadata
          • action
          • canreverse
          • connect
          • connected
          • connecting
          • description
          • devicestate
          • disconnect
          • driverinfo
          • driverversion
          • halt
          • interfaceversion
          • ismoving
          • mechanicalposition
          • move
          • moveabsolute
          • movemechanical
          • name
          • position
          • reverse
          • stepsize
          • supportedactions
          • sync
          • targetposition
      • Template Responder Class Modules
    • Physical Device Implementation
      • Simulated Rotator Device
        • RotatorDevice
    • App Startup and Device Declarations
      • Application Startup and Exception Handling
        • LoggingWSGIRequestHandler
          • LoggingWSGIRequestHandler.log_message()
        • custom_excepthook()
        • falcon_uncaught_exception_handler()
        • init_routes()
        • main()
    • App Configuration and Device Settings
      • Device Configuration Support
        • Device-Specific Settings
        • Alternate Location of config.toml
        • Config class
          • Config
            • Config.addr_family
            • Config.can_reverse
            • Config.ip_address
            • Config.location
            • Config.log_level
            • Config.log_to_stdout
            • Config.max_size_mb
            • Config.num_keep_logs
            • Config.port
            • Config.step_size
            • Config.steps_per_sec
            • Config.sync_write_connected
            • Config.verbose_driver_exceptions
    • Boilerplate Support Logic
      • Exceptions - Classes Defining Alpaca Exceptions
        • Exception Classes
          • ActionNotImplementedException
          • DriverException
          • InvalidOperationException
          • InvalidValueException
          • NotConnectedException
          • NotImplementedException
          • OperationCancelledException
          • ParkedException
          • SlavedException
          • Success
          • ValueNotSetException
      • Alpaca Discovery Responder
        • DiscoveryResponder
          • DiscoveryResponder.run()
      • Master Logger Support
        • init_logging()
      • Shared Utility Functions and Metadata
        • DeviceMetadata
        • ImageArrayResponse
        • MethodResponse
          • MethodResponse.json
        • PreProcessRequest
          • PreProcessRequest.maxdev
        • PropertyResponse
          • PropertyResponse.json
  • Migrating from Earlier Versions to Platform 7
    • Migration Summary
    • Adding New members
    • Updating InterfaceVersion
    • Testing with Conform Universal
  • Python Tooling for Visual Studio Code
AlpycaDevice SDK
  • Search

© Copyright 2022-2025, ASCOM Initiative, MIT License.

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