-
Notifications
You must be signed in to change notification settings - Fork 8
Code needed to run our opmode #149
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
class Opmode: | ||
def __init__(self, robot): | ||
self.robot = robot | ||
def start(): | ||
pass | ||
def loop(): | ||
pass | ||
def stop(): | ||
pass |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,211 @@ | ||
#!/usr/bin/env python3 | ||
""" | ||
Script to run an opmode class derived from the Opmode base class. | ||
|
||
Usage: | ||
python run_opmode.py <opmode_file.py> | ||
|
||
The opmode file should contain a class that inherits from Opmode. | ||
""" | ||
|
||
import sys | ||
import time | ||
import importlib.util | ||
import inspect | ||
import argparse | ||
from pathlib import Path | ||
|
||
# Add the current directory to Python path to import local modules | ||
sys.path.insert(0, str(Path(__file__).parent)) | ||
|
||
from opmode import Opmode | ||
from robot import Robot | ||
|
||
|
||
def find_opmode_class(module): | ||
""" | ||
Find the first class in the module that inherits from Opmode. | ||
|
||
Args: | ||
module: The imported Python module | ||
|
||
Returns: | ||
The Opmode-derived class, or None if not found | ||
""" | ||
for name, obj in inspect.getmembers(module, inspect.isclass): | ||
if obj != Opmode and issubclass(obj, Opmode): | ||
return obj | ||
return None | ||
|
||
|
||
def load_opmode_from_file(file_path): | ||
""" | ||
Dynamically load an opmode class from a Python file. | ||
|
||
Args: | ||
file_path: Path to the Python file containing the opmode class | ||
|
||
Returns: | ||
The Opmode-derived class | ||
|
||
Raises: | ||
FileNotFoundError: If the file doesn't exist | ||
ImportError: If the file can't be imported | ||
ValueError: If no Opmode-derived class is found | ||
""" | ||
file_path = Path(file_path) | ||
|
||
if not file_path.exists(): | ||
raise FileNotFoundError(f"Opmode file not found: {file_path}") | ||
|
||
if not file_path.suffix == '.py': | ||
raise ValueError(f"File must be a Python file (.py): {file_path}") | ||
|
||
# Create module spec and load the module | ||
spec = importlib.util.spec_from_file_location("opmode_module", file_path) | ||
if spec is None or spec.loader is None: | ||
raise ImportError(f"Could not load module from {file_path}") | ||
|
||
module = importlib.util.module_from_spec(spec) | ||
spec.loader.exec_module(module) | ||
|
||
# Find the Opmode-derived class | ||
opmode_class = find_opmode_class(module) | ||
if opmode_class is None: | ||
raise ValueError(f"No class derived from Opmode found in {file_path}") | ||
|
||
return opmode_class | ||
|
||
|
||
def run_opmode(opmode_file, duration=None, loop_frequency=50): | ||
""" | ||
Run the opmode with the specified parameters. | ||
|
||
Args: | ||
opmode_file: Path to the opmode Python file | ||
duration: How long to run in seconds (None for infinite) | ||
loop_frequency: Loops per second (default: 50 Hz) | ||
""" | ||
print(f"Loading opmode from: {opmode_file}") | ||
|
||
try: | ||
# Load the opmode class | ||
OpModeClass = load_opmode_from_file(opmode_file) | ||
print(f"Found opmode class: {OpModeClass.__name__}") | ||
|
||
# Create robot instance | ||
print("Creating robot instance...") | ||
robot = Robot() | ||
|
||
# Create opmode instance | ||
print("Initializing opmode...") | ||
opmode = OpModeClass(robot) | ||
|
||
# Call start method | ||
print("Starting opmode...") | ||
opmode.start() | ||
|
||
# Calculate loop timing | ||
loop_period = 1.0 / loop_frequency | ||
print(f"Running main loop at {loop_frequency} Hz...") | ||
|
||
# Main loop | ||
loop_count = 0 | ||
start_time = time.time() | ||
|
||
try: | ||
while True: | ||
loop_start = time.time() | ||
|
||
# Call the loop method | ||
opmode.loop() | ||
loop_count += 1 | ||
|
||
# Check if we should stop based on duration | ||
if duration is not None and (time.time() - start_time) >= duration: | ||
break | ||
|
||
# Sleep to maintain loop frequency | ||
elapsed = time.time() - loop_start | ||
sleep_time = max(0, loop_period - elapsed) | ||
|
||
if sleep_time > 0: | ||
time.sleep(sleep_time) | ||
elif elapsed > loop_period * 1.1: # Warn if loop is running slow | ||
print(f"Warning: Loop {loop_count} took {elapsed:.3f}s " | ||
f"(target: {loop_period:.3f}s)") | ||
|
||
except KeyboardInterrupt: | ||
print("\nReceived interrupt signal...") | ||
|
||
# Call stop method | ||
print("Stopping opmode...") | ||
opmode.stop() | ||
|
||
# Print statistics | ||
total_time = time.time() - start_time | ||
actual_frequency = loop_count / total_time if total_time > 0 else 0 | ||
|
||
print(f"\nOpmode completed:") | ||
print(f" Total runtime: {total_time:.2f} seconds") | ||
print(f" Total loops: {loop_count}") | ||
print(f" Average frequency: {actual_frequency:.1f} Hz") | ||
|
||
except Exception as e: | ||
print(f"Error running opmode: {e}") | ||
sys.exit(1) | ||
|
||
|
||
def main(): | ||
"""Main entry point.""" | ||
parser = argparse.ArgumentParser( | ||
description="Run an opmode class derived from Opmode", | ||
formatter_class=argparse.RawDescriptionHelpFormatter, | ||
epilog=""" | ||
Examples: | ||
python run_opmode.py my_opmode.py | ||
python run_opmode.py my_opmode.py --duration 30 | ||
python run_opmode.py my_opmode.py --frequency 60 | ||
""" | ||
) | ||
|
||
parser.add_argument( | ||
'opmode_file', | ||
help='Python file containing the opmode class' | ||
) | ||
|
||
parser.add_argument( | ||
'--duration', '-d', | ||
type=float, | ||
help='Duration to run in seconds (default: run until interrupted)' | ||
) | ||
|
||
parser.add_argument( | ||
'--frequency', '-f', | ||
type=int, | ||
default=50, | ||
help='Loop frequency in Hz (default: 50)' | ||
) | ||
|
||
parser.add_argument( | ||
'--verbose', '-v', | ||
action='store_true', | ||
help='Enable verbose output' | ||
) | ||
|
||
args = parser.parse_args() | ||
|
||
if args.frequency <= 0: | ||
print("Error: Frequency must be positive") | ||
sys.exit(1) | ||
|
||
# Run the opmode | ||
run_opmode( | ||
args.opmode_file, | ||
duration=args.duration, | ||
loop_frequency=args.frequency | ||
) | ||
|
||
|
||
if __name__ == '__main__': | ||
main() |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.