Git Product home page Git Product logo

pygmc's Introduction

PyGMC

PyGMC is a Python library for interfacing with the GQ Electronics GMC 500, 500+, 600, and 600+ Geiger-Muller Counters using the device's custom protocol. It implements all documented commands and provides an easy-to-use interface for accessing and updating the device configuration.

Installation

pip install pygmc

Usage

from pygmc import GMCConnection, GMCGeigerCounter

# Establish a connection
connection = GMCConnection(port='COM4')

# Create a Geiger counter instance
geiger = GMCGeigerCounter(connection=connection)

# Fetch the current CPM (Counts Per Minute)
cpm = geiger.get_CPM()

# Print the CPM
print(cpm)

Documentation

Detailed documentation for each method is provided in the source code itself. The following are a few key methods and what they do:

  • GMCGeigerCounter.get_CPM(): Fetches the current CPM (Counts Per Minute) from the device.
  • GMCGeigerCounter.get_battery_voltage(): Fetches the battery voltage from the device.
  • GMCGeigerCounter.get_config(): Fetches the current device configuration.
  • GMCGeigerCounter.set_config(config): Sets the device configuration. The config parameter should be a dictionary matching the structure defined in the config_format constant.
  • GMCGeigerCounter.reboot(): Reboots the device.
  • GMCGeigerCounter.factory_reset(): Resets the device to factory settings.

You can find the complete list of methods and their description in the GMCGeigerCounter class in the code.

Contributing

We welcome contributions from the community! If you have suggestions for improvements, please open an issue to discuss your ideas or feel free to submit a pull request.

pygmc's People

Contributors

ctoth avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.