sls/hla_framework_bd
0
1
Fork 0
Code Issues 28 Pull Requests 2 Actions Packages Projects 1 Releases Wiki Activity

docs: update add new service docs

Browse Source
This commit is contained in:
Benjamin Labrecque
2026-07-28 08:29:34 +02:00
parent 1188cd383b
commit df817a0aee
1 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/user/add-new-service.md
+9 -7
View File
@@ -4,9 +4,11 @@
Install the [uv](https://docs.astral.sh/uv/) package manager
## CLI
## CLI (Command-Line Interface)
Using the CLI:
We have our own cli called `agebd`.
To use the cli, first clone this repo. Then:
```
cd cli
@@ -36,7 +38,7 @@ The services are deployed to 2 environments:
We distinguish between
- `prod` vs `dev` PVs
- **services specific** PVs from a dedicated IOC vs **external** PVs from other IOCs
- **service specific** PVs from a dedicated IOC vs **external** PVs from other IOCs
#### PVs - Service Specific
@@ -49,15 +51,15 @@ In your code, you only use the `prod` name of a PV. The framework will automatic
#### PVs - External
You can only access them. The framework will use the same PV in `prod` and `dev`,
i.e. there is no `dev` PV.
The framework will use the same PV in `prod` and `dev`, i.e. there is no `dev` PV.
However, in `dev` you can only read from the PV, whereas in `prod` you can also write to it.
#### PVs - Examples
| Environment | Service Specific | External |
|---|---|---|
|`prod` | `PV("AGEBD-MYSERVICE:MYPVNAME")` | `PV("AGEOP-SOME-SERVICE:SOME-PVNAME")` |
| `dev` | `PV("AGEBD-MYSERVICE-DEV:MYPVNAME")` | - |
|`prod` | `PV("AGEBD-MYSERVICE:MYPVNAME")` read&write | `PV("AGEOP-SOME-SERVICE:SOME-PVNAME")` read&write |
| `dev` | `PV("AGEBD-MYSERVICE-DEV:MYPVNAME")` read&write | `PV("AGEOP-SOME-SERVICE:SOME-PVNAME")` readonly |
### Python