Skip to main content

Python Lib to control lunaticoastro dragonfly

Project description

Lunaticoastro Dragonfly Controller

Python code serves as a client that controls and queries a dome (DragonFly Dome) controller over a network, allowing it to send commands, and fetch relay and sensor data remotely.

Once the container is running you can open the API at http://<container_ip>:8080/docs/

DragonFly Dome Controller

This Docker container provides an isolated environment for running a server that interfaces with the DragonFly Dome controller, allowing remote command sending and data retrieval.

Getting Started

These instructions will cover usage information and for the docker container.

DockerHub

The image is available on the Docker Hub at robbrad182/dragonfly-dome-controller:latest

Prerequisites

You need Docker installed on your system. You can download it from Docker's website.

Installing

Clone the repository to get the required files:

git clone https://github.com/robbrad/lunaticoastro-dragonfly-controller.git 
cd lunaticoastro-dragonfly-controller

Building the Docker Image

Build the Docker image using the following command:

docker build -t dragonfly-dome-controller .

This command builds the Docker image with the tag dragonfly-dome-controller, using the Dockerfile from the current directory.

Environment Variables

You need to set the following environment variables:

  • DRAGONFLY_IP: IP address of the DragonFly Dome controller.
  • DRAGONFLY_PORT: Port on which the DragonFly Dome controller is listening.

These can be set directly in the docker run command or through a .env file.

Running the Container

To run the container with the environment variables set, use the following command:

bashCopy code

docker run -d -p 8080:8080 --env DRAGONFLY_IP=192.168.x.x --env DRAGONFLY_PORT=10000 dragonfly-dome-controller

Replace 192.168.x.x with the actual IP address of your DragonFly Dome controller.

Additional Commands

  • To stop the container, find the container ID with docker ps and then stop it with docker stop <container-id>.
  • To remove the container once stopped, use docker rm <container-id>.
  • To view logs from the running container, use docker logs <container-id>.

Built With

  • Python - The programming language used.
  • Docker - Containerization platform.

Authors

  • Robert Bradley - Initial work - robbrad

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Acknowledgments

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

File details

Details for the file lunaticoastro_dragonfly_controller-0.14.0.tar.gz.

File metadata

File hashes

Hashes for lunaticoastro_dragonfly_controller-0.14.0.tar.gz
Algorithm Hash digest
SHA256 dba7c6603ba2b3887b1050b1e610b93107f6797b8a54d9dbe417ee4479deb629
MD5 4aeb9ecc70f02c231d6be570410f9c8d
BLAKE2b-256 6de4281ec9a4ed465193e5cdd93a08d898f4f3658f79fc59d79851bfefce43c9

See more details on using hashes here.

File details

Details for the file lunaticoastro_dragonfly_controller-0.14.0-py3-none-any.whl.

File metadata

File hashes

Hashes for lunaticoastro_dragonfly_controller-0.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d391933c47e40816f2a14e12d54f403a43cb1724088e62a375288aeb203325a7
MD5 28c498e724312c96b30104c6542617b6
BLAKE2b-256 35f771b219eaf9774188b76ec3260d09db2a37b17f2ac91e69643b9b280914d3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page