deploy: 92ba17b

DiamondLightSource · Jan 16, 2025 · 050ada8 · 050ada8
1 parent 7e75da1
commit 050ada8
Show file tree

Hide file tree

Showing 49 changed files with 818 additions and 87 deletions.
diff --git a/main/.buildinfo b/main/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 9329355661bde3796093ae440d744c5b
+config: 75f7db47963751c5fdde29ec11f9a1fc
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/main/.doctrees/how-to.doctree b/main/.doctrees/how-to.doctree
diff --git a/main/.doctrees/how-to/authenticate.doctree b/main/.doctrees/how-to/authenticate.doctree
diff --git a/main/.doctrees/reference/cli.doctree b/main/.doctrees/reference/cli.doctree
diff --git a/main/.doctrees/reference/rest-spec.doctree b/main/.doctrees/reference/rest-spec.doctree
diff --git a/main/_api.html b/main/_api.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>API &#8212; blueapi 0.7.2.dev1+gefcb4aa7 documentation</title>
+    <title>API &#8212; blueapi 0.7.2.dev2+g92ba17bc documentation</title>
 
 
 
@@ -41,7 +41,7 @@
   <link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />
 
-    <script src="_static/documentation_options.js?v=a927af4d"></script>
+    <script src="_static/documentation_options.js?v=e4519cc4"></script>
     <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/main/_api/blueapi.html b/main/_api/blueapi.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>blueapi &#8212; blueapi 0.7.2.dev1+gefcb4aa7 documentation</title>
+    <title>blueapi &#8212; blueapi 0.7.2.dev2+g92ba17bc documentation</title>
 
 
 
@@ -41,7 +41,7 @@
   <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />
 
-    <script src="../_static/documentation_options.js?v=a927af4d"></script>
+    <script src="../_static/documentation_options.js?v=e4519cc4"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/main/_sources/how-to/authenticate.md.txt b/main/_sources/how-to/authenticate.md.txt
@@ -0,0 +1,67 @@
+# Authenticate to BlueAPI
+
+## Introduction
+BlueAPI provides a secure and efficient way to interact with its services. This guide walks you through the steps to log in and log out using BlueAPI with OpenID Connect (OIDC) authentication.
+
+## Configuration
+
+:::{seealso}
+[Configure the Application](./configure-app.md)
+:::
+
+Here is an example configuration for authenticating to p46-blueapi:
+
+```yaml
+api:
+  host: "p46-blueapi.diamond.ac.uk"
+  port: 443
+  protocol: "https"
+
+auth_token_path: "~/.cache/blueapi_cache"  # Optional: Custom path to store the token
+```
+
+- **auth_token_path**: (Optional) Specify where to save the token. If omitted, the default is `~/.cache/blueapi_cache` or `$XDG_CACHE_HOME/blueapi_cache` if `XDG_CACHE_HOME` is set.
+
+---
+
+## Log In
+
+1. Execute the login command:
+
+   ```bash
+   $ blueapi -c config.yaml login
+   ```
+
+2. **Authenticate**:
+   - Follow the prompts from your OIDC provider to log in.
+   - Provide your credentials and complete any additional verification steps required by the provider.
+
+3. **Success Message**:
+   Upon successful authentication, you see the following message:
+
+   ```
+   Logged in and cached new token
+   ```
+
+---
+
+## Log Out
+
+To log out and securely remove the cached access token, follow these steps:
+
+1. Execute the logout command:
+
+   ```bash
+   $ blueapi logout
+   ```
+
+2. **Logout Process**:
+   - This command uses the OIDC flow to log you out from the OIDC provider.
+   - It also deletes the cached token from the specified `auth_token_path`.
+
+3. **Success Message**:
+   If the token is successfully removed or if it does not exist, you see the message:
+
+   ```
+   Logged out
+   ```
diff --git a/main/_static/documentation_options.js b/main/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.7.2.dev1+gefcb4aa7',
+    VERSION: '0.7.2.dev2+g92ba17bc',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/main/explanations.html b/main/explanations.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Explanations &#8212; blueapi 0.7.2.dev1+gefcb4aa7 documentation</title>
+    <title>Explanations &#8212; blueapi 0.7.2.dev2+g92ba17bc documentation</title>
 
 
 
@@ -41,7 +41,7 @@
   <link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />
 
-    <script src="_static/documentation_options.js?v=a927af4d"></script>
+    <script src="_static/documentation_options.js?v=e4519cc4"></script>
     <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/main/explanations/architecture.html b/main/explanations/architecture.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Architecture &#8212; blueapi 0.7.2.dev1+gefcb4aa7 documentation</title>
+    <title>Architecture &#8212; blueapi 0.7.2.dev2+g92ba17bc documentation</title>
 
 
 
@@ -41,7 +41,7 @@
   <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />
 
-    <script src="../_static/documentation_options.js?v=a927af4d"></script>
+    <script src="../_static/documentation_options.js?v=e4519cc4"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/main/explanations/decisions.html b/main/explanations/decisions.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Architectural Decision Records &#8212; blueapi 0.7.2.dev1+gefcb4aa7 documentation</title>
+    <title>Architectural Decision Records &#8212; blueapi 0.7.2.dev2+g92ba17bc documentation</title>
 
 
 
@@ -41,7 +41,7 @@
   <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />
 
-    <script src="../_static/documentation_options.js?v=a927af4d"></script>
+    <script src="../_static/documentation_options.js?v=e4519cc4"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/main/explanations/decisions/0001-record-architecture-decisions.html b/main/explanations/decisions/0001-record-architecture-decisions.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>1. Record architecture decisions &#8212; blueapi 0.7.2.dev1+gefcb4aa7 documentation</title>
+    <title>1. Record architecture decisions &#8212; blueapi 0.7.2.dev2+g92ba17bc documentation</title>
 
 
 
@@ -41,7 +41,7 @@
   <link rel="preload" as="script" href="../../_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />
 
-    <script src="../../_static/documentation_options.js?v=a927af4d"></script>
+    <script src="../../_static/documentation_options.js?v=e4519cc4"></script>
     <script src="../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/main/explanations/decisions/0002-switched-to-python-copier-template.html b/main/explanations/decisions/0002-switched-to-python-copier-template.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>2. Adopt python-copier-template for project structure &#8212; blueapi 0.7.2.dev1+gefcb4aa7 documentation</title>
+    <title>2. Adopt python-copier-template for project structure &#8212; blueapi 0.7.2.dev2+g92ba17bc documentation</title>
 
 
 
@@ -41,7 +41,7 @@
   <link rel="preload" as="script" href="../../_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />
 
-    <script src="../../_static/documentation_options.js?v=a927af4d"></script>
+    <script src="../../_static/documentation_options.js?v=e4519cc4"></script>
     <script src="../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/main/explanations/decisions/0003-no-queues.html b/main/explanations/decisions/0003-no-queues.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>3. No Queues &#8212; blueapi 0.7.2.dev1+gefcb4aa7 documentation</title>
+    <title>3. No Queues &#8212; blueapi 0.7.2.dev2+g92ba17bc documentation</title>
 
 
 
@@ -41,7 +41,7 @@
   <link rel="preload" as="script" href="../../_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />
 
-    <script src="../../_static/documentation_options.js?v=a927af4d"></script>
+    <script src="../../_static/documentation_options.js?v=e4519cc4"></script>
     <script src="../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/main/explanations/decisions/0004-api-case.html b/main/explanations/decisions/0004-api-case.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>4. API Model Case &#8212; blueapi 0.7.2.dev1+gefcb4aa7 documentation</title>
+    <title>4. API Model Case &#8212; blueapi 0.7.2.dev2+g92ba17bc documentation</title>
 
 
 
@@ -41,7 +41,7 @@
   <link rel="preload" as="script" href="../../_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />
 
-    <script src="../../_static/documentation_options.js?v=a927af4d"></script>
+    <script src="../../_static/documentation_options.js?v=e4519cc4"></script>
     <script src="../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/main/explanations/decisions/0005-connect-devices.html b/main/explanations/decisions/0005-connect-devices.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>5. Connect all dodal devices during startup &#8212; blueapi 0.7.2.dev1+gefcb4aa7 documentation</title>
+    <title>5. Connect all dodal devices during startup &#8212; blueapi 0.7.2.dev2+g92ba17bc documentation</title>
 
 
 
@@ -41,7 +41,7 @@
   <link rel="preload" as="script" href="../../_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />
 
-    <script src="../../_static/documentation_options.js?v=a927af4d"></script>
+    <script src="../../_static/documentation_options.js?v=e4519cc4"></script>
     <script src="../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/main/explanations/events.html b/main/explanations/events.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Events Emitted by the Worker &#8212; blueapi 0.7.2.dev1+gefcb4aa7 documentation</title>
+    <title>Events Emitted by the Worker &#8212; blueapi 0.7.2.dev2+g92ba17bc documentation</title>
 
 
 
@@ -41,7 +41,7 @@
   <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />
 
-    <script src="../_static/documentation_options.js?v=a927af4d"></script>
+    <script src="../_static/documentation_options.js?v=e4519cc4"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/main/explanations/extension-code.html b/main/explanations/extension-code.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Home of Plans and Devices &#8212; blueapi 0.7.2.dev1+gefcb4aa7 documentation</title>
+    <title>Home of Plans and Devices &#8212; blueapi 0.7.2.dev2+g92ba17bc documentation</title>
 
 
 
@@ -41,7 +41,7 @@
   <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />
 
-    <script src="../_static/documentation_options.js?v=a927af4d"></script>
+    <script src="../_static/documentation_options.js?v=e4519cc4"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/main/explanations/lifecycle.html b/main/explanations/lifecycle.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Lifecycle of a Plan &#8212; blueapi 0.7.2.dev1+gefcb4aa7 documentation</title>
+    <title>Lifecycle of a Plan &#8212; blueapi 0.7.2.dev2+g92ba17bc documentation</title>
 
 
 
@@ -41,7 +41,7 @@
   <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />
 
-    <script src="../_static/documentation_options.js?v=a927af4d"></script>
+    <script src="../_static/documentation_options.js?v=e4519cc4"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/main/explanations/plans.html b/main/explanations/plans.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Plans &#8212; blueapi 0.7.2.dev1+gefcb4aa7 documentation</title>
+    <title>Plans &#8212; blueapi 0.7.2.dev2+g92ba17bc documentation</title>
 
 
 
@@ -41,7 +41,7 @@
   <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />
 
-    <script src="../_static/documentation_options.js?v=a927af4d"></script>
+    <script src="../_static/documentation_options.js?v=e4519cc4"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/main/explanations/type_validators.html b/main/explanations/type_validators.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Type Validators &#8212; blueapi 0.7.2.dev1+gefcb4aa7 documentation</title>
+    <title>Type Validators &#8212; blueapi 0.7.2.dev2+g92ba17bc documentation</title>
 
 
 
@@ -41,7 +41,7 @@
   <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />
 
-    <script src="../_static/documentation_options.js?v=a927af4d"></script>
+    <script src="../_static/documentation_options.js?v=e4519cc4"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/main/genindex.html b/main/genindex.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; blueapi 0.7.2.dev1+gefcb4aa7 documentation</title>
+    <title>Index &#8212; blueapi 0.7.2.dev2+g92ba17bc documentation</title>
 
 
 
@@ -40,7 +40,7 @@
   <link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />
 
-    <script src="_static/documentation_options.js?v=a927af4d"></script>
+    <script src="_static/documentation_options.js?v=e4519cc4"></script>
     <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/clipboard.min.js?v=a7894cd8"></script>