Variable

class pyrogue.interfaces.stream.Variable(*, root, incGroups=None, excGroups=['NoStream'])[source]

Stream master that emits variable values as YAML frames.

Parameters:

  • root (Root) – PyRogue root node to monitor.

  • incGroups (str | list[str] | None, default: None) – Groups to include in variable updates.

  • excGroups (str | list[str] | None, default: ['NoStream']) – Groups to exclude from variable updates.

streamYaml()[source]

Generate a frame containing all variable values in YAML format. A hardware read is not generated before the frame is generated.

Return type:

None