PV WebSocket (PVWS)

List of NixOS option for deploying the PV WebSocket (PVWS) service, that enables accessing various PVs (CA, PVA, and so on) over a WebSocket.

See also

The PV WebSocket (PVWS) user guide for how to use these options.

services.pvws.enable boolean

Whether to enable the PV WebSocket service.

Default value

false

Example

true

services.pvws.openFirewall boolean

Open the firewall for the PVWS service.

Warning

This opens the firewall on all network interfaces.

Default value

false

services.pvws.package package

The PVWS package to use.

Default value

pkgs.epnix.pvws

services.pvws.settings open submodule of attribute set of (string or absolute path)

Configuration for PVWS.

These options will be passed as environment variables.

Default value

{ }

services.pvws.settings.EPICS_CA_ADDR_LIST string or (list of string) convertible to it

List of Channel Access destination IP addresses.

Each IP address can be a unicast address, or a broadcast address.

Use lib.mkForce to override values from environment.epics.ca_addr_list.

Default value

if config.environment.epics.enable
then config.environment.epics.ca_addr_list
else [];

services.pvws.settings.EPICS_CA_AUTO_ADDR_LIST string or boolean convertible to it

If set, behave as if every broadcast address of every network interface is added to EPICS_CA_ADDR_LIST.

Use lib.mkForce to override values from environment.epics.ca_auto_addr_list.

Default value

if config.environment.epics.enable
then config.environment.epics.ca_auto_addr_list
else [];

services.pvws.settings.PV_DEFAULT_TYPE string

Default PV type.

Default value

"ca"

Example

"pva"

services.pvws.settings.PV_WRITE_SUPPORT string or boolean convertible to it

Whether to enable PV write support.

Default value

false

Example

true

services.pvws.websocketBufferSize signed integer

Maximum size of websocket buffers, in bytes.

This value can be increased in the case the maximum message size is hit when subscribing to a large number of PVs.

Default value

8192

Example

131072