Channel Access gateway¶

services.ca-gateway¶

services.ca-gateway.enable boolean[source]¶

Whether to enable the Channel Access PV gateway.

Default value¶

false

Example¶

true

services.ca-gateway.openFirewall boolean[source]¶

Open the firewall for allowing Channel Access communications.

Warning

This opens the firewall on all network interfaces.

Default value¶

false

services.ca-gateway.settings null or boolean or signed integer or floating point number or string or path or list of string[source]¶

Configuration for the Channel Access PV gateway.

These options are passed onto the gateway command-line.

Available options can be seen here: https://epics.anl.gov/EpicsDocumentation/ExtensionsManuals/Gateway/Gateway.html#Starting

Default value¶

{ }

services.ca-gateway.settings.access null or path or string[source]¶

Name of file with all the EPICS access security rules in it.

PVs in the pvlist file use groups and rules defined in this file.

See the sample file gateway.pvlist in the source distribution:

https://github.com/epics-extensions/ca-gateway/blob/v2.1.3/example/GATEWAY.access

Default value¶

null

Example¶

pkgs.writeText "gateway.access" ''
  UAG(GatewayAdmin)  {gateway,smith}

  # ...
''

services.ca-gateway.settings.cip null or (list of string)[source]¶

IP address list that the gateway’s CA client uses to find the real PVs.

See the CA reference manual.

This sets environment variables EPICS_CA_AUTO_LIST=NO and EPICS_CA_ADDR_LIST.

Note

If you intend to broadcast on a port other than 5064, you will need change your firewall configuration and accept incoming UDP packets with your source port.

Default value¶

null

Example¶

[
  "192.168.1.4"
  "192.168.1.3"
]

services.ca-gateway.settings.cport 16 bit unsigned integer; between 0 and 65535 (both inclusive)[source]¶

The port which the gateway’s CA client uses to find the real PVs.

Sets environment variable EPICS_CA_SERVER_PORT.

With openFirewall = true, this option sets the port in the firewall rule for the CA broadcast reply.

Default value¶

services.ca-gateway.settings.pvlist null or path or string[source]¶

Name of file with all the allowed PVs in it.

See the sample file gateway.pvlist in the source distribution for a description of how to create this file:

https://github.com/epics-extensions/ca-gateway/blob/v2.1.3/example/GATEWAY.pvlist

Default value¶

null

Example¶

pkgs.writeText "gateway.pvlist" ''
  EVALUATION ORDER DENY, ALLOW

  .* DENY

  MY_PV ALLOW

  # ...
''

services.ca-gateway.settings.signore null or (list of string)[source]¶

IP address list that gateway’s CA server ignores.

Sets env variable EPICS_CAS_IGNORE_ADDR_LIST.

Default value¶

null

Example¶

[
  "192.168.1.5"
  "192.168.1.42"
]

services.ca-gateway.settings.sip null or (list of string)[source]¶

IP address list that gateway’s CA server listens for PV requests.

Sets env variable EPICS_CAS_INTF_ADDR_LIST.

By default, the CA server is accessible from all network interfaces configured into its host.

Default value¶

null

Example¶

[
  "192.168.1.1"
]

services.ca-gateway.settings.sport 16 bit unsigned integer; between 0 and 65535 (both inclusive)[source]¶

The port which the gateway’s CA server uses to listen for PV requests.

Sets environment variable EPICS_CAS_SERVER_PORT.

Default value¶