Skip to main content

A library and actor to communicate with an SDSS-V LVM Enclosure

Project description

lvmecp

Versions Code style: black Test Documentation Status Docker codecov

SDSS-V LVM Enclosure Control Package

Features

Prerequisite

Install Poetry by using PyPI.

$ pip install poetry
$ python create_setup.py
$ pip install -e .

Install RabbitMQ by using apt-get.

$ sudo apt-get install -y erlang
$ sudo apt-get install -y rabbitmq-server
$ sudo systemctl enable rabbitmq-server
$ sudo systemctl start rabbitmq-server

Install CLU by using PyPI.

$ pip install sdss-clu

Installation

Clone this repository.

$ git clone https://github.com/sdss/lvmecp
$ cd lvmecp
$ poetry install

Quick Start

Start the actor

Before you start the actor, you must have the PLC or simulator.

Start lvmecp actor.

$ lvmecp start

In another terminal, type clu and lvmecp ping for test.

$ clu
lvmecp ping
     07:41:22.636 lvmecp >
     07:41:22.645 lvmecp : {
         "text": "Pong."
         }

Stop lvmecp actor.

$ lvmecp stop

Example

In terminal which you are turning clu on, you can use the command for lvmecp.

$ clu
lvmecp help
13:05:25.386 lvmecp >
13:05:25.387 lvmecp : {
    "help": [
        "Usage: lvmecp [OPTIONS] COMMAND [ARGS]...",
        "",
        "Options:",
        "  --help  Show this message and exit.",
        "",
        "Commands:",
        "  dome        tasks for Dome",
        "  estop       activate the emergency status.",
        "  get_schema  Returns the schema of the actor as a JSON schema.",
        "  help        Shows the help.",
        "  keyword     Prints human-readable information about a keyword.",
        "  light       tasks for lights",
        "  monitor     return the status of HVAC system and air purge system.",
        "  ping        Pings the actor.",
        "  telemetry   return the status of the enclosure",
        "  version     Reports the version."
    ]
}
lvmecp dome status
13:05:56.294 lvmecp >
13:05:56.295 lvmecp i {
    "text": "checking the Dome"
}
13:05:56.302 lvmecp i {
    "status": {
        "Dome": "CLOSE"
    }
}
13:05:56.302 lvmecp :
lvmecp dome move
13:06:21.701 lvmecp >
13:06:21.703 lvmecp i {
    "text": "moving the Dome"
}
13:06:21.708 lvmecp i {
    "status": {
        "Dome": "OPEN"
    }
}
13:06:21.709 lvmecp :

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

sdss_lvmecp-0.8.3.tar.gz (19.5 kB view details)

Uploaded Source

Built Distribution

sdss_lvmecp-0.8.3-py3-none-any.whl (27.0 kB view details)

Uploaded Python 3

File details

Details for the file sdss_lvmecp-0.8.3.tar.gz.

File metadata

  • Download URL: sdss_lvmecp-0.8.3.tar.gz
  • Upload date:
  • Size: 19.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for sdss_lvmecp-0.8.3.tar.gz
Algorithm Hash digest
SHA256 1e173fe76d1b416ff7f35fd0007104af534f4e0f7994d4cc3822a06b81972ff8
MD5 baeb166de0f34e0432f5b654c20e4808
BLAKE2b-256 d0fa2b2e1902022bd1c1a55175493318009913e0ebfc8413809d9e18b0b8afc7

See more details on using hashes here.

File details

Details for the file sdss_lvmecp-0.8.3-py3-none-any.whl.

File metadata

  • Download URL: sdss_lvmecp-0.8.3-py3-none-any.whl
  • Upload date:
  • Size: 27.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for sdss_lvmecp-0.8.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a87e2341ec34323ec80536754d1a89a40890e36b015d7ea2cf110d2942148030
MD5 7c3cecca789904b63995e201a44d9dee
BLAKE2b-256 e70314a0a57f9b727a32a06add298f4d8c3804c776a83ecad2c3665e5ed58081

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