Welcome to the Lewis documentation!

Lewis is a Python package that makes it easy to develop complex stateful device simulations. It is licensed under GPL version 3 and the source is available on github, where you are welcome to open new issues so the package can improve.

Documentation contents:

Quickstart

Quickstart

• Quickstart Guide
  • Install Lewis
  • Run the Motor Example
  • Connect to Motor via Telnet
  • Connect to Motor via Control Client
  • Control Motor via Control API

User guide

• Adapter Specifics
  • EPICS Adapter Specifics
  • Stream Adapter Specifics
• Command line tools
  • lewis
  • lewis-control
• Remote Access to Devices
  • Accessing the Device Communication Interface
  • Value Interpretation and Syntax
  • Control Client Python API
• Remote Access to Simulation Parameters
• Usage with Python
  • Virtual environments
  • Installation via pip
  • Installation from source
  • Running from source

Developer guide

• Developing Lewis
• Framework Details
• Release Checklist
• Writing Device Simulators

Release notes

• Release notes

API reference

• API
  • lewis
    • lewis.adapters
      • lewis.adapters.epics
      • lewis.adapters.modbus
      • lewis.adapters.stream
    • lewis.core
      • lewis.core.adapters
      • lewis.core.approaches
      • lewis.core.control_client
      • lewis.core.control_server
      • lewis.core.devices
      • lewis.core.exceptions
      • lewis.core.logging
      • lewis.core.processor
      • lewis.core.simulation
      • lewis.core.statemachine
      • lewis.core.utils
    • lewis.devices
      • lewis.devices.chopper
        • lewis.devices.chopper.devices
          • lewis.devices.chopper.devices.bearings
          • lewis.devices.chopper.devices.device
          • lewis.devices.chopper.devices.states
        • lewis.devices.chopper.interfaces
          • lewis.devices.chopper.interfaces.epics_interface
      • lewis.devices.julabo
        • lewis.devices.julabo.devices
          • lewis.devices.julabo.devices.device
          • lewis.devices.julabo.devices.states
        • lewis.devices.julabo.interfaces
          • lewis.devices.julabo.interfaces.julabo_stream_interface_1
          • lewis.devices.julabo.interfaces.julabo_stream_interface_2
      • lewis.devices.linkam_t95
        • lewis.devices.linkam_t95.devices
          • lewis.devices.linkam_t95.devices.device
          • lewis.devices.linkam_t95.devices.states
        • lewis.devices.linkam_t95.interfaces
          • lewis.devices.linkam_t95.interfaces.stream_interface
    • lewis.examples
      • lewis.examples.dual_device
      • lewis.examples.example_motor
      • lewis.examples.modbus_device
      • lewis.examples.simple_device
      • lewis.examples.timeout_device
    • lewis.scripts
      • lewis.scripts.control
      • lewis.scripts.run
    • lewis.utils
      • lewis.utils.byte_conversions
      • lewis.utils.command_builder
      • lewis.utils.constants
      • lewis.utils.replies