-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
0 additions
and
118 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,127 +1,9 @@ | ||
| # lvmecp | ||
|
|
||
|  | ||
| [](https://github.com/psf/black) | ||
| [](https://github.com/sdss/lvmecp/actions/workflows/test.yml) | ||
| [](https://lvmecp.readthedocs.io/en/latest/?badge=latest) | ||
| [](https://github.com/sdss/lvmecp/actions/workflows/docker.yml) | ||
| [](https://codecov.io/gh/sdss/lvmecp) | ||
|
|
||
| SDSS-V LVM Enclosure Control Package | ||
|
|
||
| ## Features | ||
|
|
||
| - CLU Actor based interface | ||
| - Supports [DirectLogic 205 (Micro Modular PLC)](https://www.automationdirect.com/adc/overview/catalog/programmable_controllers/directlogic_series_plcs_(micro_to_small,_brick_-a-_modular)/directlogic_205_(micro_modular_plc)) | ||
|
|
||
| ## Prerequisite | ||
|
|
||
| Install [Poetry](https://python-poetry.org/) by using PyPI. | ||
|
|
||
| ``` | ||
| $ pip install poetry | ||
| $ python create_setup.py | ||
| $ pip install -e . | ||
| ``` | ||
|
|
||
| Install [RabbitMQ](https://www.rabbitmq.com/) 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](https://clu.readthedocs.io/en/latest/) 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 : | ||
| ``` |