Metadata-Version: 2.4
Name: dls-d2bpm-tools
Version: 1.0.0b2
Summary: Tools to facilitate development and maintenance of D2 BPM software
Author-email: Lee Hudson <lee.hudson@diamond.ac.uk>
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "{}"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright {yyyy} {name of copyright owner}
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
        
Project-URL: GitHub, https://github.com/DiamondLightSource/dls-d2bpm-tools
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyside6<6.10,>=6.8
Dynamic: license-file

[![CI](https://github.com/DiamondLightSource/dls-d2bpm-tools/actions/workflows/ci.yml/badge.svg)](https://github.com/DiamondLightSource/dls-d2bpm-tools/actions/workflows/ci.yml)
[![Coverage](https://codecov.io/gh/DiamondLightSource/dls-d2bpm-tools/branch/main/graph/badge.svg)](https://codecov.io/gh/DiamondLightSource/dls-d2bpm-tools)
[![PyPI](https://img.shields.io/pypi/v/dls-d2bpm-tools.svg)](https://pypi.org/project/dls-d2bpm-tools)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)

# dls-d2bpm-tools

Tools to facilitate development and maintenance of D2 BPM software.

Right now that means the **flash GUI**: a small Qt front end over the
`d2afe-cli.py` programming script. It lists the published firmware releases,
lets you pick a release, board address and network endpoint, shows you exactly
the command it is about to run, then runs it and tracks its progress. A second
tab opens a **console** on the same endpoint, for talking to a board directly.

What            | Where
:---:           | :---:
Source          | <https://github.com/DiamondLightSource/dls-d2bpm-tools>
PyPI            | `pip install dls-d2bpm-tools`
Docker          | `docker run ghcr.io/diamondlightsource/dls-d2bpm-tools:latest`
Releases        | <https://github.com/DiamondLightSource/dls-d2bpm-tools/releases>

## Running the flash GUI

```
# from a checkout, without installing anything
uv run dls-d2bpm-tools d2afe-flash

# from PyPI, in an automatically managed Python environment
uvx dls-d2bpm-tools d2afe-flash
```

Once the package is installed `dls-d2bpm-tools` is on the `PATH`, and the GUI
is its `d2afe-flash` subcommand.

`uvx` installs PySide6 and its bundled Qt libraries automatically; a separate
Qt or Python package installation is not needed. On Linux, the host still needs
an X11 display and Qt's system libraries (OpenGL, GLib, XCB, fontconfig and D-Bus).
These are normally present on a desktop, but minimal installations may need
them installed once. On Debian/Ubuntu:

```sh
sudo apt-get install -y libegl1 libgl1 libglib2.0-0t64 libxkbcommon-x11-0 libdbus-1-3 \
    libfontconfig1 libxcb-cursor0 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 \
    libxcb-randr0 libxcb-render-util0 libxcb-shape0 libxcb-xinerama0 libxcb-xkb1
```

Other distributions use different package names; see
[Qt's Linux requirements](https://doc.qt.io/qt-6.8/linux-requirements.html).
Older Debian/Ubuntu versions call the GLib package `libglib2.0-0`.
These OS libraries cannot be installed by `uvx` or declared as Python dependencies.
Both container images include them. The devcontainer also forwards `$DISPLAY`
from the host; running the release container's GUI requires forwarding the display
and its authentication, for example on a Linux X11 host:

```sh
docker run --rm --network host -e DISPLAY -e XAUTHORITY=/tmp/Xauthority \
    -v /tmp/.X11-unix:/tmp/.X11-unix:ro \
    -v "${XAUTHORITY:-$HOME/.Xauthority}:/tmp/Xauthority:ro" \
    ghcr.io/diamondlightsource/dls-d2bpm-tools:latest d2afe-flash
```

## Where firmware comes from

Two sources, switchable in the GUI:

**GitLab releases** (default) reads
<https://gitlab.diamond.ac.uk/diagnostics/d2afe-firmware/-/releases> over the
API and downloads the assets it needs, caching them under
`~/.cache/dls-d2bpm-tools/firmware/<repository-id>/<tag>/`. No token is needed on the DLS
network; set `GITLAB_TOKEN` if that ever changes. Use this from anywhere,
including machines with no `/dls_sw` mount.

To use another GitLab project or server, override the full project URL:

```sh
uvx dls-d2bpm-tools d2afe-flash \
    --firmware-repo https://gitlab.example.org/team/d2afe-firmware
```

You can also edit **Repository URL** in the GUI and press **Apply** or Enter.
The field starts with the command-line URL (or the default). Applying it selects
the GitLab source and loads releases in the background, with the same filesystem
fallback on failure. Invalid URLs are reported beside the field without replacing
the current source. Changes apply to this session only.

Nested namespaces, a trailing `.git`, and links ending in `/-/releases` are
accepted. The project must publish the same release asset layout as the default
firmware repository. Authentication still uses `GITLAB_TOKEN`, and filesystem
fallback still uses `--firmware-base`. Each repository has its own cache so
identically named releases cannot reuse another repository's firmware. Older
downloads in the previous cache layout will be downloaded again once.

**Filesystem** reads the CI build area at
`/dls_sw/work/ci-builds/d2afe-firmware`, the original behaviour. Pick the
starting source with `--source filesystem`, and point it elsewhere with
`--firmware-base`.

Both serve the same artifacts — the same CI job writes to `/dls_sw` and
attaches the release assets — so the choice is really about what the machine
can reach.

Release discovery runs in the background. If GitLab cannot be reached or its
release list cannot be read, the GUI automatically switches to the filesystem
source and explains why. If that source has no releases, Flash stays disabled
until files are available or both artifact paths are overridden. Select GitLab
again to retry it.

Downloads happen on the worker thread when you press Flash. The command preview
shows where a file *will* be cached before it is fetched. Flash captures the
selected files and connection settings immediately; editing the form during a
download cannot change the operation already in progress.

## How it picks a release

A release is only offered if it actually carries firmware for the selected
device: some tags ship one board only. The newest numbered release is
preselected, so a one-off tag like `hmc1119_1` never becomes the default.

Only the D2AFE build publishes `d2afe-cli.py`, but that script flashes both
boards, so a D2PTD flash borrows it from the D2AFE side of the same release.

Each of the binary and the script can be overridden with an explicit path if
you want to flash something from your own working copy. Anything that can't be
resolved after source fallback is reported in the command
preview, with the Flash button disabled, rather than in a dialog.

> Releases created before the firmware CI was fixed to keep `*.py` in its build
> artifacts — 0.9.2 and earlier, and hmc1119_1 — link to a `d2afe-cli.py` that
> isn't in the archive, and will say so. Use a script override or the
> filesystem source for those. Releases from 0.9.3-beta.1 onwards carry the
> script.

## The console tab

The Console tab opens a session on the same IP and port used for flashing, so
you can talk to a board between flashes without leaving the app or unplugging
anything.

It is a **raw TCP** connection, not telnet, and that distinction matters. The
endpoint is a serial device server in TCP server mode, where the socket is a
pipe onto the RS485 bus. A telnet client opens by sending IAC negotiation
bytes, which every board on the bus would see as noise, and would in turn eat
parts of their replies as if they were negotiation. If you want to reach the
same port from a shell, use `nc <ip> <port>`, not `telnet`.

Two consequences of the bus being shared, both surfaced in the tab:

- **Everything is a broadcast.** What you send reaches every board on that
  port, and their replies come back interleaved. The board address used for
  flashing means nothing here.
- **Only one thing can hold the port.** Pressing Flash disconnects the console
  first and says so, and the Connect button is disabled while a flash runs.

Lines are terminated with CRLF by default, since that is what the D2AFE console
expects; CR and LF are selectable. Local echo is on by default,
because half-duplex RS485 will not echo your keystrokes back to you.

## Development

```
uv sync                             # create the venv
uv run pytest                       # tests (the GUI ones run offscreen)
uv run ruff check src tests         # lint
uv run pyright src tests            # types
tox -p                              # everything CI runs
```

`dls_d2bpm_tools.firmware` holds the domain model (devices, artifacts, the
command line) and `dls_d2bpm_tools.sources` the two firmware sources. Neither
imports Qt, and the tests stub the one HTTP call, so the suite needs no display
and no network.
