microsync

Contents:

  • Installation Guide
    • Python Driver Installation
      • Prerequisites
      • Install Dependencies
      • Install the microsync Driver
      • Verify Installation
    • Firmware Installation
      • Prerequisites
      • Build the Firmware
      • Upload to Arduino Due
    • Hardware Setup
      • Required Connections
      • Power Supply
      • Driver Installation (Windows)
    • Verification
      • Test the Complete Setup
    • Troubleshooting
      • Common Issues
      • Getting Help
    • Next Steps
  • Quick Start Guide
    • Basic Setup
    • Basic Event Scheduling
    • Laser Control
    • Acquisition Modes
    • System Control
    • Configuration
    • Common Patterns
    • Next Steps
  • Python API Reference
    • Core Classes
    • Modules
      • __version__.py
    • Utility Functions
      • Event
        • Event.func
        • Event.arg1
        • Event.arg2
        • Event.ts
        • Event.N
        • Event.intvl
        • Event.unit
        • Event.__init__()
        • Event.map_func()
      • SyncDevice
        • SyncDevice.com
        • SyncDevice.func_map
        • SyncDevice._pending_tx_
        • SyncDevice._in_context
        • SyncDevice.N_events
        • SyncDevice.N_frames_left()
        • SyncDevice.__enter__()
        • SyncDevice.__exit__()
        • SyncDevice.__init__()
        • SyncDevice.cam_readout_us
        • SyncDevice.clear()
        • SyncDevice.close_shutters()
        • SyncDevice.disable_pin()
        • SyncDevice.enable_pin()
        • SyncDevice.get_events()
        • SyncDevice.get_function_addr()
        • SyncDevice.get_property()
        • SyncDevice.get_status()
        • SyncDevice.go()
        • SyncDevice.interlock_enabled
        • SyncDevice.neg_pulse()
        • SyncDevice.open_shutters()
        • SyncDevice.pos_pulse()
        • SyncDevice.prescaler
        • SyncDevice.pulse_duration_us
        • SyncDevice.pulse_train()
        • SyncDevice.query()
        • SyncDevice.reset()
        • SyncDevice.running
        • SyncDevice.selected_lasers
        • SyncDevice.set_pin()
        • SyncDevice.set_property()
        • SyncDevice.shutter_delay_us
        • SyncDevice.start_ALEX_acq()
        • SyncDevice.start_continuous_acq()
        • SyncDevice.start_stroboscopic_acq()
        • SyncDevice.stop()
        • SyncDevice.sys_time_cts
        • SyncDevice.sys_time_s
        • SyncDevice.tgl_pin()
        • SyncDevice.version
        • SyncDevice.watchdog_timeout_ms
        • SyncDevice.write()
      • props
        • props.ro_N_EVENTS
        • props.ro_SYS_TIMER_OVF_COUNT
        • props.ro_SYS_TIMER_PRESCALER
        • props.ro_SYS_TIMER_STATUS
        • props.ro_SYS_TIMER_VALUE
        • props.ro_SYS_TIME_s
        • props.ro_VERSION
        • props.ro_WATCHDOG_TIMEOUT_ms
        • props.rw_CAM_READOUT_us
        • props.rw_DFLT_PULSE_DURATION_us
        • props.rw_INTLCK_ENABLED
        • props.rw_SELECTED_LASERS
        • props.rw_SHUTTER_DELAY_us
        • props.wo_CLOSE_SHUTTERS
        • props.wo_OPEN_SHUTTERS
  • C++ Firmware Architecture
    • Overview
    • System Architecture
    • Core Components
      • Event System
      • Communication System
      • Safety Systems
      • Hardware Interface
    • Memory Management
    • Error Handling
    • Performance Characteristics
    • Build System
  • Firmware Build and Deployment
    • Building the Firmware
      • Prerequisites
      • Project Structure
      • Build Configuration
      • Build Steps
    • Upload Methods
    • Troubleshooting
      • Common Issues
    • Debugging
      • Debug Features
    • Version Management
      • Version Information
      • Version Compatibility
  • C++ API Reference
    • Class Hierarchy
    • File Hierarchy
    • Full API
      • Classes and Structs
        • Struct DataPacket
        • Struct pin_map_t
        • Class DeviceProperty
        • Class ExternalProperty
        • Class FunctionProperty
        • Class InternalProperty
        • Class Pin
      • Enums
        • Enum PropertyAccess
        • Enum SysProps
      • Functions
        • Function __attribute__
        • Function close_shutters
        • Function close_shutters_func
        • Function cts2us
        • Function current_time_cts
        • Function current_time_s
        • Function current_time_us
        • Function dbg_pin_dn
        • Function dbg_pin_up
        • Function disable_pin_func
        • Function enable_pin_func
        • Function err_led_off
        • Function err_led_on
        • Function event_from_datapacket
        • Function get_property
        • Function init_burst_timer
        • Function init_interlock
        • Function init_pins
        • Function init_props
        • Function init_sys_timer
        • Function init_uart_comm
        • Function is_event_missed
        • Function open_shutters
        • Function open_shutters_func
        • Function pause_sys_timer
        • Function pin_name_to_ioport_id(const char *)
        • Function pin_name_to_ioport_id(const uint32_t)
        • Function poll_uart
        • Function process_events
        • Function schedule_burst
        • Function schedule_disable_pin
        • Function schedule_enable_pin
        • Function schedule_event
        • Function schedule_pin
        • Function schedule_pulse(const DataPacket *, bool)
        • Function schedule_pulse(uint32_t, uint32_t, uint64_t, uint32_t, uint32_t, bool)
        • Function schedule_shutter_pulse
        • Function schedule_toggle
        • Function select_lasers
        • Function selected_lasers
        • Function set_pin_event_func
        • Function set_property
        • Function start_ALEX_acq
        • Function start_burst_func
        • Function start_continuous_acq
        • Function start_stroboscopic_acq
        • Function start_sys_timer
        • Function stop_burst_func
        • Function stop_sys_timer
        • Function tgl_pin_event_func
        • Function uart_tx(const char *)
        • Function uart_tx(const char *, uint32_t)
        • Function us2cts
      • Variables
        • Variable default_pulse_duration_us
        • Variable Event
        • Variable event_queue
        • Variable interlock_enabled
        • Variable lasers_enabled
        • Variable pin_map
        • Variable pins
        • Variable shutter_pins
        • Variable sys_tc_ovf_count
        • Variable sys_timer_running
      • Defines
        • Define BURST_PIN
        • Define CAMERA_PIN
        • Define CY2_PIN
        • Define CY3_PIN
        • Define CY5_PIN
        • Define CY7_PIN
        • Define DBG_PIN
        • Define ERR_PIN
        • Define ID_INTLCK_TC
        • Define ID_SYS_TC
        • Define ID_UART_TC
        • Define INTLCK_IN
        • Define INTLCK_OUT
        • Define INTLCK_OUT_PERIPH
        • Define INTLCK_TC
        • Define INTLCK_TC_CH
        • Define INTLCK_TC_Handler
        • Define INTLCK_TC_IRQn
        • Define INTLCK_TC_PERIOD_US
        • Define INTLCK_TIOB
        • Define MAX_N_EVENTS
        • Define MIN_EVENT_INTERVAL
        • Define PRESC32
        • Define SYS_TC
        • Define SYS_TC_CH
        • Define SYS_TC_CMR_TCCLKS_TIMER_CLOCK
        • Define SYS_TC_CONVERSION_MULTIPLIER
        • Define SYS_TC_Handler
        • Define SYS_TC_IRQn
        • Define SYS_TC_PRESCALER
        • Define TS_MISSED_TOLERANCE
        • Define TS_MISSED_TOLERANCE_CTS
        • Define TS_TOLERANCE
        • Define TS_TOLERANCE_CTS
        • Define UART_BAUDRATE
        • Define UART_BUFFER_SIZE
        • Define UART_TC
        • Define UART_TC_CH
        • Define UART_TC_IRQn
        • Define UART_TIMEOUT
        • Define UART_TIMEOUT_Handler
        • Define UNIFORM_TIME_DELAY
        • Define UNIFORM_TIME_DELAY_CTS
        • Define VERSION
        • Define WATCHDOG_TIMEOUT
      • Typedefs
        • Typedef EventFunc
        • Typedef PropGetter
        • Typedef PropSetter
microsync
  • Search

© Copyright 2025, Roman Kiselev.

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