Pokeys_py

[zarfld]

Software Requirements Specification (SRS) for pokeys_py

1. Introduction

1.1 Purpose

The purpose of this document is to outline the software requirements for pokeys_py, a Python interface for interacting with PoKeys devices. This library will facilitate communication with various peripherals supported by the PoKeys hardware, including digital I/O, analog I/O, counters, PWM outputs, and more. Create subfolder 'pokeys_py' for Python Implementation which will BE provided in parallel to the c comp implementations

1.2 Scope

pokeys_py will provide a unified interface for controlling PoKeys devices in a LinuxCNC environment, ensuring compatibility with real-time requirements for motion control. The library will be modular, allowing for easy expansion and maintenance.

1.3 References

• PoKeysLib C API
• PoKeys Python Wrapper
• PoKeys UDP Interface
• LinuxCNC Documentation
• LinuxCNC Motion Control

2. Overall Description

2.1 Product Perspective

pokeys_py is designed to be a part of a larger control system for CNC machines, providing direct interaction with PoKeys devices through a Python API. It will abstract the complexities of the underlying hardware, allowing users to easily manage various peripheral types.

2.2 Product Features

• Modular Design: Each type of peripheral (digital I/O, analog I/O, etc.) will have its own module for clear separation of functionality.
• Real-time Performance: The library will facilitate real-time updates, especially for motion control through the PEv2 interface.
• Compatibility: Designed to work seamlessly with LinuxCNC for controlling CNC machines.

3. Functional Requirements

3.1 Digital I/O Module

• Setup: Initialize digital pins and configure settings.
• Fetch: Retrieve the current state of digital inputs.
• Set: Write values to digital outputs.
• References:
  • Digital I/O Implementation

3.2 Analog I/O Module

• Setup: Initialize analog input/output pins.
• Fetch: Retrieve analog input values.
• Set: Write analog output values.
• References:
  • Analog I/O Documentation

3.3 PWM Module

• Setup: Initialize PWM channels and configure settings.
• Fetch: Retrieve current PWM values.
• Set: Write new PWM values (duty cycle, frequency).
• References:
  • PWM Implementation

3.4 Counter Module

• Setup: Initialize digital counters.
• Fetch: Retrieve current counter values.
• Set: Clear or reset counters.
• References:
  • Counter Implementation

3.5 PoNET Module

• Setup: Initialize PoNET connections.
• Fetch: Retrieve data from PoNET devices.
• Set: Send data to PoNET devices.
• References:
  • PoNET Documentation

3.6 PEv2 Motion Control Module

• Setup: Configure axes and parameters for motion control.
• Fetch: Retrieve current motion status and position feedback.
• Set: Send position and velocity commands to axes.
• References:
  • PEv2 Implementation

4. Non-Functional Requirements

4.1 Performance Requirements

• The library should support real-time updates for motion control with minimal latency.
• Should efficiently handle concurrent requests to the device.

4.2 Security Requirements

• Ensure secure communication with the PoKeys device, especially when using network features.

4.3 Maintainability

• The code should be modular and follow best practices for readability and maintainability.

5. System Requirements

5.1 Software Requirements

• Python 3.x
• Required libraries: pyserial, numpy (for real-time data processing)

5.2 Hardware Requirements

• Compatible PoKeys device (e.g., PoKeys57CNC, PoKeys57E)
• Computer with USB or network interface to connect to the PoKeys device.

6. Glossary

• PoKeys Device: A hardware interface for connecting various peripherals.
• Digital I/O: General-purpose input and output pins.
• Analog I/O: Input and output pins for analog signals.
• PWM: Pulse-width modulation for controlling power delivery.
• PEv2: Pulse engine v2 for motion control.
• LinuxCNC: Open-source software for controlling CNC machines.

---

This SRS provides a comprehensive overview of the pokeys_py library, its requirements, and its intended functionality. The references included will assist developers in understanding the underlying hardware and existing libraries for further development and implementation.