caput

Put values to EPICS PV(s).

Description

  • Put values to EPICS PV(s).

Parameters

Parameter

Type

Required

Default

Comment

pvname

str|list[str]

Yes

-

A pvname or a list of pvname.

repeat_value

bool

No

None

Put the same value to every PV if True.

timeout

float

No

5.0

Wait time.

value

Any|list[Any]

Yes

-

A value or a list of value.

Examples

# Put to a single PV.
# Output: {'name': 'TEST:PV1', 'ok': True}
- caput:
    pvname: "TEST:PV1"
    value: 1.0

# Put 1 to TEST:PV1 and 2 to TEST:PV2.
# Output: [
#  {'name': 'TEST:PV1', 'ok': True}
#  {'name': 'TEST:PV2', 'ok': True}
# ]
- caput:
    pvname: ["TEST:PV1", "TEST:PV2"]
    value: [1.0, 2.0]

# Put 1 to TEST:PV1 and TEST:PV2 with repeat_value.
# Output: [
#  {'name': 'TEST:PV1', 'ok': True}
#  {'name': 'TEST:PV2', 'ok': True}
# ]
- caput:
    pvname: ["TEST:PV1", "TEST:PV2"]
    value: 1.0
    repeat_value: yes

# Put to a single pv data with timeout.
# Timeout Output: {'name': 'TEST:PV1', 'ok': False}
- caput:
    pvname: "TEST:PV1"
    value: 1.0
    timeout: 1.0