https://github.com/opensight-cv/upgraded-engineer

Python "API" for interacting with rusty-engine
https://github.com/opensight-cv/upgraded-engineer

frc potential-engine python3

Last synced: 4 months ago
JSON representation

Python "API" for interacting with rusty-engine

• Host: GitHub
• URL: https://github.com/opensight-cv/upgraded-engineer
• Owner: opensight-cv
• License: mit
• Created: 2019-05-16T00:45:50.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2020-01-11T04:02:53.000Z (over 6 years ago)
• Last Synced: 2025-10-07T13:59:34.587Z (8 months ago)
• Topics: frc, potential-engine, python3
• Language: Python
• Homepage:
• Size: 46.9 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
upgraded-engineer

===

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)

[![PyPI](https://img.shields.io/pypi/v/upgraded-engineer.svg)](https://pypi.org/project/upgraded-engineer/)

`upgraded-engineer` is a Python library for interacting with [`rusty-engine`.](https://github.com/opensight-cv/rusty-engine)

## Installation

`pip install upgraded-engineer`

### Dependencies

* GStreamer (base and bad plugins required for `upgraded-engineer`, more required by `rusty-engine`)

* Open CV (known working with >= 4.0.0, must be compiled with GStreamer support)

## Usage

Importing is simple:

```python

import engine

```

To simply start a new `rusty-engine` process, create an instance of the `engine.Engine` class. You will have to figure out how to write frames into the shared memory yourself. (Note that `rusty-engine` is expecting I420 color, and cannot determine what is being written for itself.)

Alternatively, using `engine.EngineWriter`s provide the `write_frame` method to write "normal" Open CV BGR color frames into shared memory for streaming.

```python

import engine

# see also: engine.GStreamerEngineWriter for a GStreamer-only impl

ew = engine.OpenCVEngineWriter()

# alternately, if we wanted smaller video

ew = engine.OpenCVEngineWriter(video_size=(426, 240, 30)) # width, height, framerate

```

Now, writing frames into shared memory is simple.

```python

def on_new_frame_whenever_that_is_for_you(frame):

    ew.write_frame(frame) # ew.write_frame handles the BGR to I420 conversion automagically

```