Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

Alex Wallace The release of this newsletter was delayed and then delayed again as at first we were coming back from a winter break and then trying to wrap up our overhaul of the supported device list (SDL).

Future of Cameras

  • Discontinue Pulnix camera usage
    • Identified as problematic, and should be replaced at the earliest opportunity.
    • Currently classified as DO NOT USE in our SDL.
  • Deprioritizing CamLink Development
    • Halting further development of CamLink including: new feature requests, new camera integrations, bugfixes, and integration of new libraries.
    • Still the only way to get a real "hardware" timestamp on a frame at 120Hz.
  • Moving towards USB3
    • Current camera integration requests are mostly USB 3 
    • Prioritizing development of solution for proper timestamping but it seems OK for now (OBO issues).
  • See SDL list.

...

ECS Supported Device List

The supported device list (SDL) is a primary component of our Confluence documentation. The original intent of the SDL was to document what kinds of devices users, and other LCLS teams could bring to LCLS that could be integrated with the control system (I think). Then it sort of morphed into a list that tried to capture details of any device we had used with the control system. Things like manuals, datasheets, self-written user guides. Our unwritten rule for device support development were to create a page for a new device. This resulted in some pages being perfectly sufficient, others being woefully sparse, and still others excessively verbose, nearly to the point of duplicating a manual. Furthermore the SDL became a sort of Interface Control Document (ICD) between PCDS and other teams. Sometimes we might say, "is it on the SDL?" and if the answer was no, then we didn't support a device. Other times the answer didn't matter. Other times we just wanted people to leave us alone and so they were referred to the SDL. Someone perusing the SDL might occasionally find a listing had a part number, and then place an order without a another check. Other issues included perhaps ordering a piece of hardware they found on the list, only to find that it had been ordered with a different interface than we had seen before, or any other variety of divergent configurations. There were problems. 

So we set out to revamp this crucial system. You can see some of our notes here: 2021-11-12 ECS PDG Meeting Notes 2021-11-19 ECS PDG Meeting Notes.

A few months later and we're nearly done with the overhaul. Of course this is really just the start. There are probably many devices that didn't quite make it into the new list. Most of our work focused on stuff that had been in the list before. We defined a standard way of creating new device pages (called stubs), created an easy to use template button, a page labelling scheme to organize our content, and leveraged some cool Confluence macros. We ended up with a collection of stubs, which we then worked on properly organizing (highlighting another area of Confluence that needed attention, our Subsystems area). The stubs have also given us an excellent structure for further organization of our help-guides and notes on particular devices. 

Other notable features about the new SDL include: global scope, the ability to create arbitrary organizations of stubs. The former means anyone anywhere on confluence (in any space), can make a stub, and if they use our labeling scheme, we can include the stub in our lists, meaning our stubs can be merged with other groups to form a lab-wide view of supported devices. The latter meaning we can organize stubs according to any category we create a label for. As an example, a temperature controller might be used for multiple categories, timing system stabilization or sample delivery instrumentation. By applying each subsystem label, plus one for "thermal controls" we can then present this device in any of those contexts. So anyone perusing our SDL collection could find that temperature controller multiple ways, meaning there's a better chance of them locating information they need quickly.

Finally one of the best features in the new system is the indication of support status. The previous SDL had to maintain information on all devices in production, even (and maybe even especially) the ones we might have wanted to see retired. This would lead to confusion as other people viewing the list might misunderstand that just because something was on the list didn't mean it was still "supported." Now the SDL uses a specific label for Long Term Support, End of Life and Do Not Use so it is crystal clear if the device you're looking at is really still supported or if we're just keeping a stub around to make sure we never buy another one... More explanation of these terms is available on the SDL page: Supported Devices.Alex Wallace 

QRIX

We have been busy with testing, checkouts and install of QRIX endstation Controls. The schedule has been pulled forward with tasks that needs to be completed/ready in preparation for Toyama's visit to install and checkout the spectrometer arm.

...