0.12.0

Breaking Changes

• EpicsCAIOC options parameter removed - The options parameter has been removed from EpicsCAIOC(pv_prefix, controller_api, options=...)
  • Pass EPICS options via the transport config instead.
• on_update is now blocking by default - Previously on_update callbacks were non-blocking; they are now awaited before proceeding. This can change timing behaviour.
• AttrR.update() validates before calling callbacks - If validation fails, an error is logged and the value is not updated.
• DATATYPE_DTYPES removed - Replaced by the DType union.
  • use DType instead.
• bind_logger removed from public API - bind_logger has been removed
  • from fastcs.logging import bind_logger; bind_logger(...) -> `from fastcs.logging import logger
• ControllerVector is now generic on Controller_T
  • ControllerVector must now be parameterised with a specific Controller
• add_on_update_callback(always=False) - always flag added to AttrR.add_on_update_callback to let callbacks fire even when the value hasn't changed. The default is now to not fire the callback if the value has not changed, the previous behaviour was always=True.

Fixes

• AttrRW setpoint callbacks called with validated value - Sync setpoint callbacks in AttrRW now receive self._value (the validated value) rather than the raw input.
• 2D+ Waveforms skipped in EPICS CA - Multi-dimensional waveforms are skipped (with a warning) in the EPICS CA transport rather than raising an error or being handled incorrectly.

New Features

• AttrR.wait_for_value / wait_for_predicate - New async methods on AttrR to block until an attribute reaches a target value or satisfies a custom predicate, with a timeout.
• DataType.equal / DataType.all_equal - Static helper methods on all DataType subclasses to compare values correctly (e.g. using np.array_equal for array types).
• DType union type - Replaces the old DATATYPE_DTYPES tuple. DType is a proper union type alias; DType_T is now TypeVar("DType_T", bound=DType).
• Improved scan task handling / reconnect - Scan tasks are now paused on exception and can be restarted with Controller.reconnect, rather than requiring restarting the entire application.
  • Note: To make use of this overridden Controller.connect methods must now set self._connected = True, and Controller.reconnect should be implemented to restore the connection for scan tasks - by default reconnect will just start the scan tasks again
  • reconnect() can be called in the interactive shell, or a driver can implement a @scan method that checks for disconnect and automatically handles reconnection.
• Logger uses file path and line numbers - Log messages now include source file path and line number for easier debugging.

Other

• Package rename: FastCS → fastcs

---

What's Changed

• Escape < in logging extras so they aren't treated as colour tags by @GDYendell in #279
• Improve Attribute hint validation and add Controller hint validation by @GDYendell in #281
• Log exceptions in failed scan tasks by @GDYendell in #282
• Add AttrR wait_for_value by @GDYendell in #284
• Correctly implement DType and DType_T by @GDYendell in #285
• Add DataType equal and all_equal helpers by @GDYendell in #289
• Fix command buttons in pva transport by @GDYendell in #294
• Refactor Methods to allow overridding @command methods by @GDYendell in #293
• Implement Waveform by @GDYendell in #247
• Pass precision to widget for Int and Float by @GDYendell in #299
• Windows: add guards for some methods that don't work/exist on windows by @Tom-Willemsen in #295
• Set AttrW after Put in pva transport by @shihab-dls in #292
• Update to copier template 5.0.1 by @GDYendell in #302
• Add historical ADRs by @GDYendell in #305
• Add access_mode property to Attribute classes (#260) by @GDYendell in #307
• Add always flag to add_on_update_callback by @shihab-dls in #311
• Call sync setpoint callbacks with validated value by @GDYendell in #315
• Improve String validation by @GDYendell in #317
• Handle unsupported Waveforms with warning messages by @GDYendell in #316
• Remove unused options parameter from EpicsCAIOC by @JamesOHeaDLS in #322
• Pass attribute instead of datatype into _get_read_widget by @jacob720 in #321
• Refactor EPICS CA record creation by @ajgdls in #319
• 313 make logger use file path and line by @JamesOHeaDLS in #323
• Log error when AttrR fails to validate value in update by @GDYendell in #330
• Validate hinted methods by @shihab-dls in #320
• Make ControllerVector generic on Controller_T by @shihab-dls in #326
• Improve handling of failed scan tasks and allow reconnect by @GDYendell in #332
• Update to copier 5.0.2 and rename FastCS -> fastcs by @GDYendell in #335

New Contributors

• @Tom-Willemsen made their first contribution in #295
• @jacob720 made their first contribution in #321

Full Changelog: 0.11.3...0.12.0

0.12.0a2

What's Changed

• Windows: add guards for some methods that don't work/exist on windows by @Tom-Willemsen in #295
• Set AttrW after Put in pva transport by @shihab-dls in #292
• Update to copier template 5.0.1 by @GDYendell in #302
• Add historical ADRs by @GDYendell in #305
• Add access_mode property to Attribute classes (#260) by @GDYendell in #307
• Add always flag to add_on_update_callback by @shihab-dls in #311
• Call sync setpoint callbacks with validated value by @GDYendell in #315
• Improve String validation by @GDYendell in #317
• Handle unsupported Waveforms with warning messages by @GDYendell in #316
• Remove unused options parameter from EpicsCAIOC by @JamesOHeaDLS in #322
• Pass attribute instead of datatype into _get_read_widget by @jacob720 in #321
• Refactor EPICS CA record creation by @ajgdls in #319
• 313 make logger use file path and line by @JamesOHeaDLS in #323
• Log error when AttrR fails to validate value in update by @GDYendell in #330
• Validate hinted methods by @shihab-dls in #320
• Make ControllerVector generic on Controller_T by @shihab-dls in #326

New Contributors

• @Tom-Willemsen made their first contribution in #295
• @jacob720 made their first contribution in #321

Full Changelog: 0.12.0a1...0.12.0a2

0.12.0a1

What's Changed

• Escape < in logging extras so they aren't treated as colour tags by @GDYendell in #279
• Improve Attribute hint validation and add Controller hint validation by @GDYendell in #281
• Log exceptions in failed scan tasks by @GDYendell in #282
• Add AttrR wait_for_value by @GDYendell in #284
• Correctly implement DType and DType_T by @GDYendell in #285
• Add DataType equal and all_equal helpers by @GDYendell in #289
• Fix command buttons in pva transport by @GDYendell in #294
• Refactor Methods to allow overridding @command methods by @GDYendell in #293
• Implement Waveform by @GDYendell in #247
• Pass precision to widget for Int and Float by @GDYendell in #299

Full Changelog: 0.11.3...0.12.0a1

0.11.3

What's Changed

• Update AttrR.update to take value: Any by @GDYendell in #278

Full Changelog: 0.11.2...0.11.3

0.11.2

What's Changed

• Move snake_to_pascal back to root util by @GDYendell in #277

Full Changelog: 0.11.1...0.11.2

0.11.1

What's Changed

• Add stdio-socket to dependencies for use in containers by @GDYendell in #276

Full Changelog: 0.11.0...0.11.1

0.11.0

Summary

• Updater, Sender and Handler have been replaced with AttributeIO and AttributeIORef
  • This removes the circular dependency of Controller -> Attribute -> Handler -> Controller and simplifies the API for writing drivers
• TransportOptions and TransportAdapter merged into Transport. Transports are now constructed with options and passed into FastCS directly
• Backend merged into FastCS
• SubControllers have been removed. There is now no special handling required for controllers that will be registered as sub controllers - Controller can be registered as a sub controller.
• Controllers are now attributes of a parent Controller and can be registered and accessed with the dot accessor
• @put methods have been removed
• New Controller.disconnect hook added to allow clean up just before the application stops
• New logging and tracing frameworks
  • Use fastcs.logging.logger for debug, info, warning, error with nice formatting
  • Call fastcs.logging.configure_logging to enable logging (default level info)
  • Use Tracer for trace level logging that can be configured on the console at runtime per object (e.g. attr.enable_tracing()). Some classes (Attribute, AttributeIO, Controller) inherit this, so they have self.log_event for trace messages. For other cases inherit Tracer or add a module level Tracer
  • Call fastcs.logging.configure_logging(LogLevel.TRACE) so that enabled trace logging is displayed
• Attribute(description=) will now be passed to pvi to use as the label hover text
• ControllerVector added to represent a set of sub controllers distinguished by and index. e.g. Odin: N FrameProcessors or PandA: N CALC blocks.
• Type hints on controller classes are now validated at runtime to check they have been populated
• Simplified module structure
• Many other fixes and improvements

Breaking Changes

• Packaging
  • Update fastcs requirement to include the desired transports, e.g. fastcs[epicsca]
• Handlers
  • Split classes inheriting Updater / Sender / Handler into AttributeIORef with the static properties and AttributeIO with update and send (previously put) methods
  • Remove initialise method
  • Update Controller to create instances of the AttributeIOs required by its attributes. Pass down to any sub controllers that also need them. The connection used by the IO can be passed in at this point (or anything else required) to use in update and send instead of being passed the whole controller
  • Update created attributes to take io_ref=MyAttributeIORef() instead of handler/sender/updater=MyHandler()
• Attributes
  • Remove SimpleHandler() from attributes - this is now the default behavior if an attribute is not passed io_ref
  • Change attr.set -> attr.update
  • Change attr.process -> attr.put(sync_setpoint=True)
  • Change attr.process_without_display_update -> attr.put
  • Change attr.update_display_without_process -> attr.put
  • Change attr.add_on_set_callback -> attr.add_on_update_callback
  • Change attr.add_write_display_callback -> attr.add_sync_setpoint_callback
  • Change attr.add_process_callback -> attr.add_on_put_callback
• Transport
  • Update to pass (e.g.) EpicsCATransport instead of EpicsTransportOptions, with the same arguments, to FastCS
  • Remove calls to create_docs and create_gui. If options for these are provided then these methods will be called automatically
• SubController
  • Update any classes inheriting SubController to inherit Controller
  • Change register_sub_controller -> add_sub_controller or assignment with the dot accessor (self.<sub_controller_name> = <sub_controller>)
• Controller
  • Attempting to overwrite an Attribute now raises a RuntimeError, even if the type and access mode match. To statically type hint an Attribute to be validated during initialisation, only specify the type hint on the class - do not create a default instance, e.g. attr: AttrRW[int], not attr = AttrRW(Int()).
  • Controller.attributes is now a read-only view. Use Controller.add_attribute("<attr_name>", <attr>) or direct assignment (controller.<attr_name> = <attr>) to create Attributes, which will perform validation and attach them to the controller to use in the interactive shell.
• Imports
  • from fastcs.attribute_io -> from fastcs.attributes
  • from fastcs.attribute_io_ref -> from fastcs.attributes
  • from fastcs.controller -> from fastcs.controllers
  • from fastcs.cs_methods -> from fastcs.methods
  • from fastcs.transport -> from fastcs.transports
  • from fastcs.wrappers -> from fastcs.methods
  • from fastcs.attributes import ONCE -> from fastcs.util import ONCE
  • fastcs.transport.epics.options import EpicsGUIOptions, EpicsIOCOptions -> from fastcs.transports.epics import EpicsGUIOptions, EpicsIOCOptions
  • from fastcs.transport.epics.ca.transport import EpicsCATransport -> from fastcs.transports.epics.ca import EpicsCATransport
  • Rename from fastcs.datatypes import T -> from fastcs.datatypes import DType_T

What's Changed

• Merge TransportAdapter and TransportOptions by @hyperrealist in #220
• Add transport extras by @hyperrealist in #221
• Update transport model creation for new class structure by @GDYendell in #223
• Remove SubController by @hyperrealist in #222
• Replace Handler with AttributeIO / AttributeIORef by @jsouter in #218
• Removes Backend class and moves logic and free functions to Launch fi… by @gkalua in #225
• Add logging framework and Tracer by @GDYendell in #224
• Fix Transport imports by @GDYendell in #227
• Fix softioc system test by @jsouter in #229
• Fix docs build by @GDYendell in #231
• Update tutorials by @GDYendell in #234
• Improve Controller Attribute and sub controller creation with setattr by @GDYendell in #235
• Redesign attribute callbacks by @GDYendell in #237
• Split launch.py into control_system.py and controller_api.py by @GDYendell in #240
• Remove Put methods by @GDYendell in #241
• Controller disconnect by @GDYendell in #243
• Tidying by @GDYendell in #233
• Update construction of DbDevInfo by @GDYendell in #249
• Tidying by @GDYendell in #250
• Remove helm charts by @GDYendell in #251
• fastcs-odin developments by @GDYendell in #258
• Pass bool record *NAM fields for Bool() Attributes by @GDYendell in #261
• Implement SubControllerVector by @shihab-dls in #192
• Make sure initial values are respected in CA transport by @jsouter in #257
• Fix EpicsCATransport to pass length with initial_value for string records by @GDYendell in #262
• Match Transport keys to toolnames by @hyperrealist in #263
• Remove EpicsCAOptions class by @GDYendell in #264
• validate hinted attributes on subcontrollers by @jsouter in #209
• Add timeouts to tests by @hyperrealist in #266
• Fix warnings in tests by @hyperrealist in #267
• Hinted attribute validation by @GDYendell in #268
• Add logging to tutorial by @GDYendell in #269
• Increase docs snippet test timeout by @GDYendell in #270
• Fix alarm status on Command PVs by @GDYendell in #265
• Do not error when rendering edl files by @jsouter in #271
• Logging fixes by @GDYendell in #273
• Move PvaEpicsGUI to pva/gui.py by @GDYendell in #274
• Improve module structure by @GDYendell in #275

New Contributors

• @hyperrealist made their first contribution in #220
• @gkalua made their first contribution in #225

Full Changelog: 0.10.1...0.11.0

0.11.0a4

Breaking Changes

• Attempting to overwrite an Attribute now raises a RuntimeError, even if the type and access mode match. To statically type hint an Attribute to be validated during initialisation, only specify the type hint on the class - do not create a default instance, e.g. attr: AttrRW[int], not attr = AttrRW(Int()).
• Controller.attributes is now a read-only view. Use Controller.add_attribute("<attr_name>", <attr>) or direct assignment (controller.<attr_name> = <attr>) to create Attributes, which will perform validation and attach them to the controller to use in the interactive shell.

What's Changed

• validate hinted attributes on subcontrollers by @jsouter in #209
• Add timeouts to tests by @hyperrealist in #266
• Fix warnings in tests by @hyperrealist in #267
• Hinted attribute validation by @GDYendell in #268
• Add logging to tutorial by @GDYendell in #269
• Increase docs snippet test timeout by @GDYendell in #270
• Fix alarm status on Command PVs by @GDYendell in #265

Full Changelog: 0.11.0a3...0.11.0a4

0.11.0a3

What's Changed

• Pass bool record *NAM fields for Bool() Attributes by @GDYendell in #261
• Implement SubControllerVector by @shihab-dls in #192
• Make sure initial values are respected in CA transport by @jsouter in #257
• Fix EpicsCATransport to pass length with initial_value for string records by @GDYendell in #262
• Match Transport keys to toolnames by @hyperrealist in #263
• Remove EpicsCAOptions class by @GDYendell in #264

Full Changelog: 0.11.0a2...0.11.0a3

0.11.0a2

What's Changed

• fastcs-odin developments by @GDYendell in #258

Full Changelog: 0.11.0a1...0.11.0a2