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.5.0.tar.gz (18.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sdss_lvmecp-0.5.0-py3-none-any.whl (25.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sdss_lvmecp-0.5.0.tar.gz
  • Upload date:
  • Size: 18.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for sdss_lvmecp-0.5.0.tar.gz
Algorithm Hash digest
SHA256 b25c12cb520873c09164866692367507a34530d6b598a69422047ae2ea851b7c
MD5 ab713cb64b1213c7db3de4a82bfe690f
BLAKE2b-256 4ece5024490ce8cf97ff1ef8c0efaefb45511db44ed9ab017df52a72b53486a2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sdss_lvmecp-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 25.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for sdss_lvmecp-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 39817a798f4cfc04ba3dc3f35e7045c8693f477f7214f1ed6c1565f33aac4268
MD5 f816dbba6f07a3f6101274ee31bd092c
BLAKE2b-256 864bb1f149b4eb5f37ea84b5eb317c81a1b70021fd217227cc049c87f887900c

See more details on using hashes here.

Supported by

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