From f38996e2af5bc1c3a1df54f214e9a3a7efb9db34 Mon Sep 17 00:00:00 2001 From: Matthew Pritchard Date: Wed, 17 Aug 2022 16:31:28 +0100 Subject: [PATCH 1/5] #9: Add minimal PMAC device for simple IOC startup --- examples/configs/pmac.yaml | 12 ++++ tickit_devices/pmac/__init__.py | 3 + tickit_devices/pmac/pmac.py | 109 ++++++++++++++++++++++++++++++++ 3 files changed, 124 insertions(+) create mode 100644 examples/configs/pmac.yaml create mode 100644 tickit_devices/pmac/__init__.py create mode 100644 tickit_devices/pmac/pmac.py diff --git a/examples/configs/pmac.yaml b/examples/configs/pmac.yaml new file mode 100644 index 00000000..f01fbf79 --- /dev/null +++ b/examples/configs/pmac.yaml @@ -0,0 +1,12 @@ +- tickit.devices.source.Source: + name: source + inputs: {} + value: 42.0 +- tickit_devices.pmac.PMAC: + name: pmac + inputs: + flux: source:value +- tickit.devices.sink.Sink: + name: sink + inputs: + flux: pmac:flux \ No newline at end of file diff --git a/tickit_devices/pmac/__init__.py b/tickit_devices/pmac/__init__.py new file mode 100644 index 00000000..c8fbd2b3 --- /dev/null +++ b/tickit_devices/pmac/__init__.py @@ -0,0 +1,3 @@ +from tickit_devices.pmac.pmac import PMAC + +__all__ = ["PMAC"] diff --git a/tickit_devices/pmac/pmac.py b/tickit_devices/pmac/pmac.py new file mode 100644 index 00000000..d0095764 --- /dev/null +++ b/tickit_devices/pmac/pmac.py @@ -0,0 +1,109 @@ +from dataclasses import dataclass + +from tickit.adapters.composed import ComposedAdapter +from tickit.adapters.interpreters.command import CommandInterpreter +from tickit.adapters.interpreters.command.regex_command import RegexCommand +from tickit.adapters.interpreters.wrappers import ( + BeheadingInterpreter, + SplittingInterpreter, +) +from tickit.adapters.servers.tcp import TcpServer +from tickit.core.components.component import Component, ComponentConfig +from tickit.core.components.device_simulation import DeviceSimulation +from tickit.core.device import Device, DeviceUpdate +from tickit.core.typedefs import SimTime +from tickit.utils.byte_format import ByteFormat +from tickit.utils.compat.typing_compat import TypedDict + + +class PMACDevice(Device): + + Inputs: TypedDict = TypedDict("Inputs", {"flux": float}) + Outputs: TypedDict = TypedDict("Outputs", {"flux": float}) + + def __init__(self) -> None: + pass + + def update(self, time: SimTime, inputs: Inputs) -> DeviceUpdate[Outputs]: + print("Updating\n") + return DeviceUpdate(self.Outputs(flux=2.0), None) + + +class PMACAdapter(ComposedAdapter): + + device: PMACDevice + + def __init__( + self, + host: str = "localhost", + port: int = 1025, + ) -> None: + """A PMAC which instantiates a TcpServer with configured host and port. + + Args: + device (Device): The device which this adapter is attached to + raise_interrupt (Callable): A callback to request that the device is + updated immediately. + host (Optional[str]): The host address of the TcpServer. Defaults to + "localhost". + port (Optional[int]): The bound port of the TcpServer. Defaults to 1025. + """ + super().__init__( + TcpServer(host, port, ByteFormat(b"%b\n")), + BeheadingInterpreter( + SplittingInterpreter(CommandInterpreter(), b" ", b""), + header_size=8, + ), + ) + + @RegexCommand(rb"\r?\n?") + async def parse_just_bytes(self): + return b"\r" + + @RegexCommand(rb"(?i:CID)\r?\n?") + async def get_cid(self): + return b"603382\r" + + @RegexCommand(rb"(?i:CPU)\r?\n?") + async def get_cpu(self): + return b"DSP56321\r" + + @RegexCommand(rb"#([1-8])[pP]\r?\n?") + async def get_axis_position(self, axis_no: int): + return str(1.0).encode() + b"1\r" + + @RegexCommand(rb"#([1-8])[fF]\r?\n?") + async def get_axis_following_error(self): + # target - current + return b"0\r" + + @RegexCommand(rb"#([1-8])\?\r?\n?") + async def get_axis_status(self): + return b"880000018401\r" + + @RegexCommand(rb"[mM]([0-9]{1,4})\r?\n?") + async def m_var(self): + return b"1\r" + + @RegexCommand(rb"[iI][0-9]{1,4}\r?\n?") + async def i_var(self): + return b"2\r" + + @RegexCommand(rb"\?\?\?\r?\n?") + async def get_status(self): + return b"000000000000\r" + + +@dataclass +class PMAC(ComponentConfig): + """PMAC accessible over TCP.""" + + host: str = "localhost" + port: int = 1025 + + def __call__(self) -> Component: # noqa: D102 + return DeviceSimulation( + name=self.name, + device=PMACDevice(), + adapters=[PMACAdapter(host=self.host, port=self.port)], + ) From e0087ff2ca296ea8f68b4f90db0df09c0e7b51c5 Mon Sep 17 00:00:00 2001 From: Matthew Pritchard Date: Mon, 22 Aug 2022 12:51:12 +0100 Subject: [PATCH 2/5] 11 implement get and set commands for p and m vars --- tickit_devices/pmac/pmac.py | 36 ++++++++++++++++++++++++++++++++---- 1 file changed, 32 insertions(+), 4 deletions(-) diff --git a/tickit_devices/pmac/pmac.py b/tickit_devices/pmac/pmac.py index d0095764..e900f7fa 100644 --- a/tickit_devices/pmac/pmac.py +++ b/tickit_devices/pmac/pmac.py @@ -15,6 +15,11 @@ from tickit.utils.byte_format import ByteFormat from tickit.utils.compat.typing_compat import TypedDict +M_TRAJ_VERSION = 4049 +M_TRAJ_BUFSIZE = 4037 +M_TRAJ_A_ADR = 4041 +M_TRAJ_B_ADR = 4042 + class PMACDevice(Device): @@ -22,7 +27,16 @@ class PMACDevice(Device): Outputs: TypedDict = TypedDict("Outputs", {"flux": float}) def __init__(self) -> None: - pass + self.mvars = [0.0] * 16000 + self.mvars[M_TRAJ_VERSION] = 3.0 + self.mvars[M_TRAJ_BUFSIZE] = 1000 + self.mvars[M_TRAJ_A_ADR] = 0x40000 + self.mvars[M_TRAJ_B_ADR] = 0x30000 + self.mvars[70] = 11990 + self.mvars[71] = 554 + self.mvars[72] = 2621 + self.mvars[73] = 76 + self.pvars = [0.0] * 16000 def update(self, time: SimTime, inputs: Inputs) -> DeviceUpdate[Outputs]: print("Updating\n") @@ -81,9 +95,23 @@ async def get_axis_following_error(self): async def get_axis_status(self): return b"880000018401\r" - @RegexCommand(rb"[mM]([0-9]{1,4})\r?\n?") - async def m_var(self): - return b"1\r" + @RegexCommand(rb"[mM]([0-9]{1,5})\r?\n?") # 1-4 or 1-5? + async def get_m_var(self, mvar: int): + return f"{self.device.mvars[mvar]}\r".encode() + + @RegexCommand(rb"[mM]([0-9]{1,5})=([0-9]*.?[0-9]*)\r?\n?") + async def set_m_var(self, mvar: int, value: float): + self.device.mvars[mvar] = value + return b"\r" + + @RegexCommand(rb"[pP]([0-9]{1,5})\r?\n?") # 1-4 or 1-5? + async def get_p_var(self, pvar: int): + return f"{self.device.pvars[pvar]}\r".encode() + + @RegexCommand(rb"[pP]([0-9]{1,5})=([0-9]*.?[0-9]*)\r?\n?") + async def set_p_var(self, pvar: int, value: float): + self.device.pvars[pvar] = value + return b"\r" @RegexCommand(rb"[iI][0-9]{1,4}\r?\n?") async def i_var(self): From e96d8c496f2625c477eb886cddfb15abc254f83d Mon Sep 17 00:00:00 2001 From: Matthew Pritchard Date: Mon, 22 Aug 2022 13:09:06 +0100 Subject: [PATCH 3/5] #11: Add docstrings to p/mvar getting/setting command functions --- tickit_devices/pmac/pmac.py | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/tickit_devices/pmac/pmac.py b/tickit_devices/pmac/pmac.py index e900f7fa..bb9fe9fc 100644 --- a/tickit_devices/pmac/pmac.py +++ b/tickit_devices/pmac/pmac.py @@ -97,19 +97,41 @@ async def get_axis_status(self): @RegexCommand(rb"[mM]([0-9]{1,5})\r?\n?") # 1-4 or 1-5? async def get_m_var(self, mvar: int): + """Regex bytestring command that returns the value of a specific mvar. + + Args: + mvar (int): the mvar to be returned. + """ return f"{self.device.mvars[mvar]}\r".encode() @RegexCommand(rb"[mM]([0-9]{1,5})=([0-9]*.?[0-9]*)\r?\n?") async def set_m_var(self, mvar: int, value: float): + """Regex bytestring command that sets the value of a specific mvar. + + Args: + mvar (int): the mvar to be set. + value (float): the value for the mvar to be set to. + """ self.device.mvars[mvar] = value return b"\r" @RegexCommand(rb"[pP]([0-9]{1,5})\r?\n?") # 1-4 or 1-5? async def get_p_var(self, pvar: int): + """Regex bytestring command that returns the value of a specific pvar. + + Args: + pvar (int): the p var to be returned. + """ return f"{self.device.pvars[pvar]}\r".encode() @RegexCommand(rb"[pP]([0-9]{1,5})=([0-9]*.?[0-9]*)\r?\n?") async def set_p_var(self, pvar: int, value: float): + """Regex bytestring command that sets the value of a specific pvar. + + Args: + pvar (int): the pvar to be set. + value (float): the value for the pvar to be set to. + """ self.device.pvars[pvar] = value return b"\r" From 3336a9fa9f2455d914e1586e81b835a2dc1dec3d Mon Sep 17 00:00:00 2001 From: Matthew Pritchard Date: Mon, 5 Sep 2022 16:28:20 +0100 Subject: [PATCH 4/5] #9: Update PmacAdapter to use JoiningInterpreter --- tickit_devices/pmac/pmac.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/tickit_devices/pmac/pmac.py b/tickit_devices/pmac/pmac.py index d0095764..35cab1f2 100644 --- a/tickit_devices/pmac/pmac.py +++ b/tickit_devices/pmac/pmac.py @@ -5,6 +5,7 @@ from tickit.adapters.interpreters.command.regex_command import RegexCommand from tickit.adapters.interpreters.wrappers import ( BeheadingInterpreter, + JoiningInterpreter, SplittingInterpreter, ) from tickit.adapters.servers.tcp import TcpServer @@ -51,7 +52,9 @@ def __init__( super().__init__( TcpServer(host, port, ByteFormat(b"%b\n")), BeheadingInterpreter( - SplittingInterpreter(CommandInterpreter(), b" ", b""), + JoiningInterpreter( + SplittingInterpreter(CommandInterpreter(), b" "), b"" + ), header_size=8, ), ) From 2771595c6b2113d501133245a962844a55cb9da8 Mon Sep 17 00:00:00 2001 From: Matthew Pritchard Date: Mon, 5 Sep 2022 17:54:08 +0100 Subject: [PATCH 5/5] #11: Replace p/mvar lists with dicts --- tickit_devices/pmac/pmac.py | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/tickit_devices/pmac/pmac.py b/tickit_devices/pmac/pmac.py index 3baacfc8..4ac77f74 100644 --- a/tickit_devices/pmac/pmac.py +++ b/tickit_devices/pmac/pmac.py @@ -1,4 +1,5 @@ from dataclasses import dataclass +from typing import Dict from tickit.adapters.composed import ComposedAdapter from tickit.adapters.interpreters.command import CommandInterpreter @@ -28,7 +29,7 @@ class PMACDevice(Device): Outputs: TypedDict = TypedDict("Outputs", {"flux": float}) def __init__(self) -> None: - self.mvars = [0.0] * 16000 + self.mvars = dict() self.mvars[M_TRAJ_VERSION] = 3.0 self.mvars[M_TRAJ_BUFSIZE] = 1000 self.mvars[M_TRAJ_A_ADR] = 0x40000 @@ -37,7 +38,7 @@ def __init__(self) -> None: self.mvars[71] = 554 self.mvars[72] = 2621 self.mvars[73] = 76 - self.pvars = [0.0] * 16000 + self.pvars: Dict = dict() def update(self, time: SimTime, inputs: Inputs) -> DeviceUpdate[Outputs]: print("Updating\n") @@ -105,6 +106,9 @@ async def get_m_var(self, mvar: int): Args: mvar (int): the mvar to be returned. """ + value = self.device.mvars.get(mvar, None) + if value is None: + self.device.mvars[mvar] = 0 return f"{self.device.mvars[mvar]}\r".encode() @RegexCommand(rb"[mM]([0-9]{1,5})=([0-9]*.?[0-9]*)\r?\n?") @@ -125,6 +129,9 @@ async def get_p_var(self, pvar: int): Args: pvar (int): the p var to be returned. """ + value = self.device.pvars.get(pvar, None) + if value is None: + self.device.pvars[pvar] = 0 return f"{self.device.pvars[pvar]}\r".encode() @RegexCommand(rb"[pP]([0-9]{1,5})=([0-9]*.?[0-9]*)\r?\n?")