diff --git a/README.md b/README.md index 7f5521b..0a74206 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,6 @@ The folder "utils" contains utility scripts for working with pmac motor controll - writeRead.py: Allows sending commands to and receiving commands from a pmac controller over an ethernet connection. - analyzeTcpDump.py: Parse the TCP communication between an IOC and a MCU and format it into a dictionary. "demo.py" shows how this data can be easily visualized for analysis. - -## Developer guide - ### Usage in IOC shell turboPmac exports the following IOC shell functions: @@ -30,8 +27,10 @@ The full turboPmacX.cmd file looks like this: epicsEnvSet("NAME","turboPmacX") epicsEnvSet("ASYN_PORT","p$(NAME)") -# Create the TCP/IP socket used to talk with the controller. The socket can be adressed from within the IOC shell via the port name -drvAsynIPPortConfigure("$(ASYN_PORT)","172.28.101.24:1025") +# Create the TCP/IP socket used to talk with the controller. The socket can be adressed from within the IOC shell via the port name. +# We do not use the standard asyn port driver here, but a PMAC-specific one which enables the usage of StreamDevices for +# communicating with the controller directly. +pmacAsynIPConfigure("$(ASYN_PORT)","172.28.101.24:1025") # Create the controller object with the defined name and connect it to the socket via the port name. # The other parameters are as follows: @@ -60,6 +59,8 @@ dbLoadTemplate("$(TOP)/$(NAME).substitutions", "INSTR=$(INSTR)$(NAME):,CONTROLLE dbLoadRecords("$(sinqMotor_DB)/asynRecord.db","P=$(INSTR)$(NAME),PORT=$(ASYN_PORT)") ``` +## Developer guide + ### Versioning Please see the documentation for the module sinqMotor: https://git.psi.ch/sinq-epics-modules/sinqmotor/-/blob/main/README.md.