pms-infra-serial (empty) → 0.0.1.0
raw patch · 11 files changed
+1239/−0 lines, 11 filesdep +aesondep +asyncdep +base
Dependencies added: aeson, async, base, base16-bytestring, bytestring, conduit, data-default, directory, fast-logger, filepath, hspec, hspec-discover, lens, monad-logger, mtl, network, pms-domain-model, pms-infra-serial, process, safe-exceptions, serialport, stm, text, transformers, unix
Files
- CHANGELOG.md +5/−0
- LICENSE +202/−0
- README.md +16/−0
- pms-infra-serial.cabal +141/−0
- src/PMS/Infra/Serial/App/Control.hs +61/−0
- src/PMS/Infra/Serial/DM/Constant.hs +40/−0
- src/PMS/Infra/Serial/DM/Type.hs +142/−0
- src/PMS/Infra/Serial/DS/Core.hs +399/−0
- src/PMS/Infra/Serial/DS/Utility.hs +129/−0
- test/PMS/Infra/Serial/App/ControlSpec.hs +103/−0
- test/Spec.hs +1/−0
+ CHANGELOG.md view
@@ -0,0 +1,5 @@+# Revision history for pms-infra-serial++## 0.0.1.0 -- 2025-07-14++* First version.
+ LICENSE view
@@ -0,0 +1,202 @@++ Apache License+ Version 2.0, January 2004+ http://www.apache.org/licenses/++ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION++ 1. Definitions.++ "License" shall mean the terms and conditions for use, reproduction,+ and distribution as defined by Sections 1 through 9 of this document.++ "Licensor" shall mean the copyright owner or entity authorized by+ the copyright owner that is granting the License.++ "Legal Entity" shall mean the union of the acting entity and all+ other entities that control, are controlled by, or are under common+ control with that entity. For the purposes of this definition,+ "control" means (i) the power, direct or indirect, to cause the+ direction or management of such entity, whether by contract or+ otherwise, or (ii) ownership of fifty percent (50%) or more of the+ outstanding shares, or (iii) beneficial ownership of such entity.++ "You" (or "Your") shall mean an individual or Legal Entity+ exercising permissions granted by this License.++ "Source" form shall mean the preferred form for making modifications,+ including but not limited to software source code, documentation+ source, and configuration files.++ "Object" form shall mean any form resulting from mechanical+ transformation or translation of a Source form, including but+ not limited to compiled object code, generated documentation,+ and conversions to other media types.++ "Work" shall mean the work of authorship, whether in Source or+ Object form, made available under the License, as indicated by a+ copyright notice that is included in or attached to the work+ (an example is provided in the Appendix below).++ "Derivative Works" shall mean any work, whether in Source or Object+ form, that is based on (or derived from) the Work and for which the+ editorial revisions, annotations, elaborations, or other modifications+ represent, as a whole, an original work of authorship. For the purposes+ of this License, Derivative Works shall not include works that remain+ separable from, or merely link (or bind by name) to the interfaces of,+ the Work and Derivative Works thereof.++ "Contribution" shall mean any work of authorship, including+ the original version of the Work and any modifications or additions+ to that Work or Derivative Works thereof, that is intentionally+ submitted to Licensor for inclusion in the Work by the copyright owner+ or by an individual or Legal Entity authorized to submit on behalf of+ the copyright owner. For the purposes of this definition, "submitted"+ means any form of electronic, verbal, or written communication sent+ to the Licensor or its representatives, including but not limited to+ communication on electronic mailing lists, source code control systems,+ and issue tracking systems that are managed by, or on behalf of, the+ Licensor for the purpose of discussing and improving the Work, but+ excluding communication that is conspicuously marked or otherwise+ designated in writing by the copyright owner as "Not a Contribution."++ "Contributor" shall mean Licensor and any individual or Legal Entity+ on behalf of whom a Contribution has been received by Licensor and+ subsequently incorporated within the Work.++ 2. Grant of Copyright License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ copyright license to reproduce, prepare Derivative Works of,+ publicly display, publicly perform, sublicense, and distribute the+ Work and such Derivative Works in Source or Object form.++ 3. Grant of Patent License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ (except as stated in this section) patent license to make, have made,+ use, offer to sell, sell, import, and otherwise transfer the Work,+ where such license applies only to those patent claims licensable+ by such Contributor that are necessarily infringed by their+ Contribution(s) alone or by combination of their Contribution(s)+ with the Work to which such Contribution(s) was submitted. If You+ institute patent litigation against any entity (including a+ cross-claim or counterclaim in a lawsuit) alleging that the Work+ or a Contribution incorporated within the Work constitutes direct+ or contributory patent infringement, then any patent licenses+ granted to You under this License for that Work shall terminate+ as of the date such litigation is filed.++ 4. Redistribution. You may reproduce and distribute copies of the+ Work or Derivative Works thereof in any medium, with or without+ modifications, and in Source or Object form, provided that You+ meet the following conditions:++ (a) You must give any other recipients of the Work or+ Derivative Works a copy of this License; and++ (b) You must cause any modified files to carry prominent notices+ stating that You changed the files; and++ (c) You must retain, in the Source form of any Derivative Works+ that You distribute, all copyright, patent, trademark, and+ attribution notices from the Source form of the Work,+ excluding those notices that do not pertain to any part of+ the Derivative Works; and++ (d) If the Work includes a "NOTICE" text file as part of its+ distribution, then any Derivative Works that You distribute must+ include a readable copy of the attribution notices contained+ within such NOTICE file, excluding those notices that do not+ pertain to any part of the Derivative Works, in at least one+ of the following places: within a NOTICE text file distributed+ as part of the Derivative Works; within the Source form or+ documentation, if provided along with the Derivative Works; or,+ within a display generated by the Derivative Works, if and+ wherever such third-party notices normally appear. The contents+ of the NOTICE file are for informational purposes only and+ do not modify the License. You may add Your own attribution+ notices within Derivative Works that You distribute, alongside+ or as an addendum to the NOTICE text from the Work, provided+ that such additional attribution notices cannot be construed+ as modifying the License.++ You may add Your own copyright statement to Your modifications and+ may provide additional or different license terms and conditions+ for use, reproduction, or distribution of Your modifications, or+ for any such Derivative Works as a whole, provided Your use,+ reproduction, and distribution of the Work otherwise complies with+ the conditions stated in this License.++ 5. Submission of Contributions. Unless You explicitly state otherwise,+ any Contribution intentionally submitted for inclusion in the Work+ by You to the Licensor shall be under the terms and conditions of+ this License, without any additional terms or conditions.+ Notwithstanding the above, nothing herein shall supersede or modify+ the terms of any separate license agreement you may have executed+ with Licensor regarding such Contributions.++ 6. Trademarks. This License does not grant permission to use the trade+ names, trademarks, service marks, or product names of the Licensor,+ except as required for reasonable and customary use in describing the+ origin of the Work and reproducing the content of the NOTICE file.++ 7. Disclaimer of Warranty. Unless required by applicable law or+ agreed to in writing, Licensor provides the Work (and each+ Contributor provides its Contributions) on an "AS IS" BASIS,+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or+ implied, including, without limitation, any warranties or conditions+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A+ PARTICULAR PURPOSE. You are solely responsible for determining the+ appropriateness of using or redistributing the Work and assume any+ risks associated with Your exercise of permissions under this License.++ 8. Limitation of Liability. In no event and under no legal theory,+ whether in tort (including negligence), contract, or otherwise,+ unless required by applicable law (such as deliberate and grossly+ negligent acts) or agreed to in writing, shall any Contributor be+ liable to You for damages, including any direct, indirect, special,+ incidental, or consequential damages of any character arising as a+ result of this License or out of the use or inability to use the+ Work (including but not limited to damages for loss of goodwill,+ work stoppage, computer failure or malfunction, or any and all+ other commercial damages or losses), even if such Contributor+ has been advised of the possibility of such damages.++ 9. Accepting Warranty or Additional Liability. While redistributing+ the Work or Derivative Works thereof, You may choose to offer,+ and charge a fee for, acceptance of support, warranty, indemnity,+ or other liability obligations and/or rights consistent with this+ License. However, in accepting such obligations, You may act only+ on Your own behalf and on Your sole responsibility, not on behalf+ of any other Contributor, and only if You agree to indemnify,+ defend, and hold each Contributor harmless for any liability+ incurred by, or claims asserted against, such Contributor by reason+ of your accepting any such warranty or additional liability.++ END OF TERMS AND CONDITIONS++ APPENDIX: How to apply the Apache License to your work.++ To apply the Apache License to your work, attach the following+ boilerplate notice, with the fields enclosed by brackets "[]"+ replaced with your own identifying information. (Don't include+ the brackets!) The text should be enclosed in the appropriate+ comment syntax for the file format. We also recommend that a+ file or class name and description of purpose be included on the+ same "printed page" as the copyright notice for easier+ identification within third-party archives.++ Copyright [yyyy] [name of copyright owner]++ Licensed under the Apache License, Version 2.0 (the "License");+ you may not use this file except in compliance with the License.+ You may obtain a copy of the License at++ http://www.apache.org/licenses/LICENSE-2.0++ Unless required by applicable law or agreed to in writing, software+ distributed under the License is distributed on an "AS IS" BASIS,+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+ See the License for the specific language governing permissions and+ limitations under the License.
+ README.md view
@@ -0,0 +1,16 @@+# pms-infra-serial++pms-infra-serial is a Haskell module responsible for handling serial communication on top of [`pty-mcp-server`](https://github.com/phoityne/pty-mcp-server).+It provides an abstraction layer for input/output control over serial connections to network devices and embedded systems, serving as a foundation for AI-driven interactive automation.+++---++## Package Structure++---++## Module Structure+++---
+ pms-infra-serial.cabal view
@@ -0,0 +1,141 @@+cabal-version: 2.4+-- The cabal-version field refers to the version of the .cabal specification,+-- and can be different from the cabal-install (the tool) version and the+-- Cabal (the library) version you are using. As such, the Cabal (the library)+-- version used must be equal or greater than the version stated in this field.+-- Starting from the specification version 2.2, the cabal-version field must be+-- the first thing in the cabal file.++-- Initial package description 'pms-infra-serial' generated by+-- 'cabal init'. For further documentation, see:+-- http://haskell.org/cabal/users-guide/+--+-- The name of the package.+name: pms-infra-serial++-- The package version.+-- See the Haskell package versioning policy (PVP) for standards+-- guiding when and how versions should be incremented.+-- https://pvp.haskell.org+-- PVP summary: +-+------- breaking API changes+-- | | +----- non-breaking API additions+-- | | | +--- code changes with no API change+version: 0.0.1.0++-- A short (one-line) description of the package.+synopsis: pms-infra-serial++-- A longer description of the package.+description: README.md++-- The license under which the package is released.+license: Apache-2.0++-- The file containing the license text.+license-file: LICENSE++-- The package author(s).+author: phoityne.hs@gmail.com++-- An email address to which users can send suggestions, bug reports, and patches.+maintainer: phoityne.hs@gmail.com++-- A copyright notice.+copyright: 2025-2026 phoityne.hs@gmail.com+category: AI+build-type: Simple+homepage: https://github.com/phoityne/pms-infra-serial+bug-reports: https://github.com/phoityne/pms-infra-serial/issues++-- Extra doc files to be distributed with the package, such as a CHANGELOG or a README.+extra-doc-files: README.md,+ CHANGELOG.md++-- Extra source files to be distributed with the package, such as examples, or a tutorial module.+-- extra-source-files:+++library+ -- Import common warning flags.+ ghc-options: -Wall -threaded++ -- Modules exported by the library.+ exposed-modules: PMS.Infra.Serial.DM.Type,+ PMS.Infra.Serial.DS.Utility,+ PMS.Infra.Serial.DM.Constant,+ PMS.Infra.Serial.App.Control,+ PMS.Infra.Serial.DS.Core++ -- Modules included in this library but not exported.+ -- other-modules:++ -- LANGUAGE extensions used by modules in this package.+ -- other-extensions:++ -- Other library packages from which modules are imported.+ build-depends: base >= 4.18 && < 5,+ data-default,+ monad-logger,+ mtl,+ lens,+ text,+ safe-exceptions,+ fast-logger,+ conduit,+ bytestring,+ transformers,+ stm,+ async,+ process,+ filepath,+ aeson,+ directory,+ network,+ base16-bytestring,+ serialport,+ pms-domain-model++ -- Directories containing source files.+ hs-source-dirs: src++ -- Base language which the package is written in.+ default-language: Haskell2010+ -- default-extensions: LambdaCase++test-suite pms-infra-serial-test+ -- Import common warning flags.+ ghc-options: -Wall -threaded++ -- Base language which the package is written in.+ default-language: Haskell2010++ -- Modules included in this executable, other than Main.+ other-modules: PMS.Infra.Serial.App.ControlSpec++ -- LANGUAGE extensions used by modules in this package.+ -- other-extensions:++ -- The interface type and version of the test suite.+ type: exitcode-stdio-1.0++ -- Directories containing source files.+ hs-source-dirs: test++ -- The entrypoint to the test suite.+ main-is: Spec.hs++ -- Test dependencies.+ build-depends: base >= 4.18 && < 5,+ hspec,+ hspec-discover,+ data-default,+ stm,+ monad-logger,+ async,+ unix,+ lens,+ pms-domain-model,+ pms-infra-serial++ build-tool-depends:+ hspec-discover:hspec-discover
+ src/PMS/Infra/Serial/App/Control.hs view
@@ -0,0 +1,61 @@+{-# LANGUAGE LambdaCase #-}++module PMS.Infra.Serial.App.Control where++import System.IO+import qualified Control.Exception.Safe as E+import System.Log.FastLogger++import qualified PMS.Domain.Model.DM.Type as DM+import qualified PMS.Domain.Model.DS.Utility as DM++import PMS.Infra.Serial.DM.Type+import PMS.Infra.Serial.DM.Constant+import PMS.Infra.Serial.DS.Utility+import PMS.Infra.Serial.DS.Core++-- |+--+run :: DM.DomainContext ()+run domDat = do+ hPutStrLn stderr "[INFO] PMS.Infra.Serial.App.Control.run called."+ appDat <- defaultAppData+ runWithAppData appDat domDat++-- |+--+runWithAppData :: AppData -> DM.DomainContext ()+runWithAppData appDat domDat = do+ logDat <- DM.createLogger domDat _LOG_FILE_NAME+ runWithLogger logDat appDat domDat++-- |+--+runWithLogger :: (TimedFastLogger, IO ()) -> AppData -> DM.DomainContext ()+runWithLogger (logger, finalizeLogger) appDat domDat = + flip E.catchAny exception+ $ flip E.finally finalize+ $ runApp domDat appDat logger app+ >>= \case+ Right x -> return x+ Left e -> errorEnd e++ where+ finalize = do+ hPutStrLn stderr "-----------------------------------------------------------------------------"+ hPutStrLn stderr "[INFO] PMS.Infra.Serial.App.Control.run finalize called."+ finalizeLogger+ hPutStrLn stderr "-----------------------------------------------------------------------------"++ exception e = do+ hPutStrLn stderr "-----------------------------------------------------------------------------"+ hPutStrLn stderr "[ERROR] PMS.Infra.Serial.App.Control.run exception occurred."+ hPutStrLn stderr $ show e+ hPutStrLn stderr "-----------------------------------------------------------------------------"+ E.throwIO e++ errorEnd e = do+ hPutStrLn stderr "-----------------------------------------------------------------------------"+ hPutStrLn stderr "[ERROR] PMS.Infra.Serial.App.Control.run end with error."+ hPutStrLn stderr $ show e+ hPutStrLn stderr "-----------------------------------------------------------------------------"
+ src/PMS/Infra/Serial/DM/Constant.hs view
@@ -0,0 +1,40 @@+module PMS.Infra.Serial.DM.Constant where++import qualified Data.ByteString as B+import Data.Word++--------------------------------------------------------------------------------+-- |+--+_LOG_FILE_NAME :: String+_LOG_FILE_NAME = "pms-infra-serial.log"++iac :: B.ByteString+iac = B.singleton (255 :: Word8)++will :: B.ByteString+will = B.singleton (251 :: Word8)++wont :: B.ByteString+wont = B.singleton (252 :: Word8)++do_ :: B.ByteString+do_ = B.singleton (253 :: Word8)++dont :: B.ByteString+dont = B.singleton (254 :: Word8)++telopt_echo :: B.ByteString+telopt_echo = B.singleton (1 :: Word8)++telopt_suppress_ga :: B.ByteString+telopt_suppress_ga = B.singleton (3 :: Word8)++telopt_ttype :: B.ByteString+telopt_ttype = B.singleton (24 :: Word8)++telopt_naws :: B.ByteString+telopt_naws = B.singleton (31 :: Word8)++telopt_new_environ :: B.ByteString+telopt_new_environ = B.singleton (39 :: Word8)
+ src/PMS/Infra/Serial/DM/Type.hs view
@@ -0,0 +1,142 @@+{-# LANGUAGE TemplateHaskell #-}++module PMS.Infra.Serial.DM.Type where++import Control.Monad.Logger+import Control.Monad.Reader+import Control.Monad.Except+import Control.Lens+import Data.Default+import Data.Aeson.TH+import qualified Control.Concurrent.STM as STM+import Data.Word +import System.IO ++import qualified PMS.Domain.Model.DM.Type as DM+import qualified PMS.Domain.Model.DM.TH as DM++-- |+--+data AppData = AppData {+ _handleAppData :: STM.TMVar (Maybe Handle)+ , _lockAppData :: STM.TMVar ()+ , _jsonrpcAppData :: DM.JsonRpcRequest+ }++makeLenses ''AppData++defaultAppData :: IO AppData+defaultAppData = do+ mgrVar <- STM.newTMVarIO Nothing+ lock <- STM.newTMVarIO ()+ return AppData {+ _handleAppData = mgrVar+ , _lockAppData = lock+ , _jsonrpcAppData = def+ }++-- |+--+type AppContext = ReaderT AppData (ReaderT DM.DomainData (ExceptT DM.ErrorData (LoggingT IO)))++-- |+--+type IOTask = IO+++--------------------------------------------------------------------------------------------+-- |+--+data SerialStringToolParams =+ SerialStringToolParams {+ _argumentsSerialStringToolParams :: String+ } deriving (Show, Read, Eq)++$(deriveJSON defaultOptions {fieldLabelModifier = DM.dropDataName "SerialStringToolParams", omitNothingFields = True} ''SerialStringToolParams)+makeLenses ''SerialStringToolParams++instance Default SerialStringToolParams where+ def = SerialStringToolParams {+ _argumentsSerialStringToolParams = def+ }++-- |+--+data SerialIntToolParams =+ SerialIntToolParams {+ _sizeSerialIntToolParams :: Int+ } deriving (Show, Read, Eq)++$(deriveJSON defaultOptions {fieldLabelModifier = DM.dropDataName "SerialIntToolParams", omitNothingFields = True} ''SerialIntToolParams)+makeLenses ''SerialIntToolParams++instance Default SerialIntToolParams where+ def = SerialIntToolParams {+ _sizeSerialIntToolParams = def+ }+++-- |+--+data SerialWord8ArrayToolParams =+ SerialWord8ArrayToolParams {+ _dataSerialWord8ArrayToolParams :: [Word8]+ } deriving (Show, Read, Eq)++$(deriveJSON defaultOptions {fieldLabelModifier = DM.dropDataName "SerialWord8ArrayToolParams", omitNothingFields = True} ''SerialWord8ArrayToolParams)+makeLenses ''SerialWord8ArrayToolParams++instance Default SerialWord8ArrayToolParams where+ def = SerialWord8ArrayToolParams {+ _dataSerialWord8ArrayToolParams = def+ }+++-- |+--+data SerialCommandToolParams =+ SerialCommandToolParams {+ _commandSerialCommandToolParams :: String+ , _argumentsSerialCommandToolParams :: Maybe [String]+ } deriving (Show, Read, Eq)++$(deriveJSON defaultOptions {fieldLabelModifier = DM.dropDataName "SerialCommandToolParams", omitNothingFields = True} ''SerialCommandToolParams)+makeLenses ''SerialCommandToolParams++instance Default SerialCommandToolParams where+ def = SerialCommandToolParams {+ _commandSerialCommandToolParams = def+ , _argumentsSerialCommandToolParams = def+ }++-- |+--+data SerialToolParams =+ SerialToolParams {+ _deviceSerialToolParams :: String+ , _speedSerialToolParams :: Int+ } deriving (Show, Read, Eq)++$(deriveJSON defaultOptions {fieldLabelModifier = DM.dropDataName "SerialToolParams", omitNothingFields = True} ''SerialToolParams)+makeLenses ''SerialToolParams++instance Default SerialToolParams where+ def = SerialToolParams {+ _deviceSerialToolParams = def+ , _speedSerialToolParams = def+ }++-- |+--+data SerialStringArrayToolParams =+ SerialStringArrayToolParams {+ _argumentsSerialStringArrayToolParams :: [String]+ } deriving (Show, Read, Eq)++$(deriveJSON defaultOptions {fieldLabelModifier = DM.dropDataName "SerialStringArrayToolParams", omitNothingFields = True} ''SerialStringArrayToolParams)+makeLenses ''SerialStringArrayToolParams++instance Default SerialStringArrayToolParams where+ def = SerialStringArrayToolParams {+ _argumentsSerialStringArrayToolParams = def+ }
+ src/PMS/Infra/Serial/DS/Core.hs view
@@ -0,0 +1,399 @@+{-# LANGUAGE TemplateHaskell #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE LambdaCase #-}++module PMS.Infra.Serial.DS.Core where++import System.IO+import Control.Monad.Logger+import Control.Monad.IO.Class+import Control.Monad.Trans.Class+import Control.Lens+import Control.Monad.Reader+import qualified Control.Concurrent as CC +import Control.Concurrent.Async+import qualified Control.Concurrent.STM as STM+import Data.Conduit+import qualified Data.Text as T+import Control.Monad.Except+import qualified Control.Exception.Safe as E+import System.Exit+import qualified Data.Text.Encoding as TE+import Data.Aeson +import qualified Data.ByteString.Char8 as BS8+import Data.Word +import qualified Data.ByteString as B+import System.Hardware.Serialport++import qualified PMS.Domain.Model.DS.Utility as DM+import qualified PMS.Domain.Model.DM.Type as DM+import qualified PMS.Domain.Model.DM.Constant as DM++import PMS.Infra.Serial.DM.Type+import PMS.Infra.Serial.DS.Utility+++-- |+--+app :: AppContext ()+app = do+ $logDebugS DM._LOGTAG "app called."+ runConduit pipeline+ where+ pipeline :: ConduitM () Void AppContext ()+ pipeline = src .| cmd2task .| sink++---------------------------------------------------------------------------------+-- |+--+src :: ConduitT () DM.SerialCommand AppContext ()+src = lift go >>= yield >> src+ where+ go :: AppContext DM.SerialCommand+ go = do+ queue <- view DM.serialQueueDomainData <$> lift ask+ dat <- liftIO $ STM.atomically $ STM.readTQueue queue+ return dat++---------------------------------------------------------------------------------+-- |+--+cmd2task :: ConduitT DM.SerialCommand (IOTask ()) AppContext ()+cmd2task = await >>= \case+ Just cmd -> flip catchError errHdl $ do+ lift (go cmd) >>= yield >> cmd2task+ Nothing -> do+ $logWarnS DM._LOGTAG "cmd2task: await returns nothing. skip."+ cmd2task++ where+ errHdl :: String -> ConduitT DM.SerialCommand (IOTask ()) AppContext ()+ errHdl msg = do+ $logWarnS DM._LOGTAG $ T.pack $ "cmd2task: exception occurred. skip. " ++ msg+ lift $ errorToolsCallResponse $ "cmd2task: exception occurred. skip. " ++ msg+ cmd2task++ go :: DM.SerialCommand -> AppContext (IOTask ())+ go (DM.SerialEchoCommand dat) = genEchoTask dat+ go (DM.SerialOpenCommand dat) = genSerialOpenTask dat+ go (DM.SerialCloseCommand dat) = genSerialCloseTask dat+ go (DM.SerialReadCommand dat) = genSerialReadTask dat+ go (DM.SerialWriteCommand dat) = genSerialWriteTask dat+ go (DM.SerialMessageCommand dat) = genSerialMessageTask dat++---------------------------------------------------------------------------------+-- |+--+sink :: ConduitT (IOTask ()) Void AppContext ()+sink = await >>= \case+ Just req -> flip catchError errHdl $ do+ lift (go req) >> sink+ Nothing -> do+ $logWarnS DM._LOGTAG "sink: await returns nothing. skip."+ sink++ where+ errHdl :: String -> ConduitT (IOTask ()) Void AppContext ()+ errHdl msg = do+ $logWarnS DM._LOGTAG $ T.pack $ "sink: exception occurred. skip. " ++ msg+ sink++ go :: (IO ()) -> AppContext ()+ go task = do+ $logDebugS DM._LOGTAG "sink: start async."+ _ <- liftIOE $ async task+ $logDebugS DM._LOGTAG "sink: end async."+ return ()+++---------------------------------------------------------------------------------+-- |+--+genEchoTask :: DM.SerialEchoCommandData -> AppContext (IOTask ())+genEchoTask dat = do+ resQ <- view DM.responseQueueDomainData <$> lift ask+ let val = dat^.DM.valueSerialEchoCommandData++ $logDebugS DM._LOGTAG $ T.pack $ "echoTask: echo : " ++ val+ return $ echoTask resQ dat val+++-- |+--+echoTask :: STM.TQueue DM.McpResponse -> DM.SerialEchoCommandData -> String -> IOTask ()+echoTask resQ cmdDat val = flip E.catchAny errHdl $ do+ hPutStrLn stderr $ "[INFO] PMS.Infra.Serial.DS.Core.echoTask run. " ++ val++ toolsCallResponse resQ (cmdDat^.DM.jsonrpcSerialEchoCommandData) ExitSuccess val ""++ hPutStrLn stderr "[INFO] PMS.Infra.Serial.DS.Core.echoTask end."++ where+ errHdl :: E.SomeException -> IO ()+ errHdl e = toolsCallResponse resQ (cmdDat^.DM.jsonrpcSerialEchoCommandData) (ExitFailure 1) "" (show e)++-- |+--+genSerialOpenTask :: DM.SerialOpenCommandData -> AppContext (IOTask ())+genSerialOpenTask cmdDat = do+ let argsBS = DM.unRawJsonByteString $ cmdDat^.DM.argumentsSerialOpenCommandData++ resQ <- view DM.responseQueueDomainData <$> lift ask+ serialMVar <- view handleAppData <$> ask+ prompts <- view DM.promptsDomainData <$> lift ask+ lockTMVar <- view lockAppData <$> ask+ argsDat <- liftEither $ eitherDecode $ argsBS+++ let device = argsDat^.deviceSerialToolParams+ speed = argsDat^.speedSerialToolParams++ settings <- getSerialSetting speed+ $logDebugS DM._LOGTAG $ T.pack $ "genSerialOpenTask: cmd. " ++ device ++ ":" ++ show settings+ + return $ serialOpenTask cmdDat resQ serialMVar lockTMVar prompts device settings+++-- |+-- +serialOpenTask :: DM.SerialOpenCommandData+ -> STM.TQueue DM.McpResponse+ -> STM.TMVar (Maybe Handle)+ -> STM.TMVar () -- lock+ -> [String] -- prompt list+ -> String -- device+ -> SerialPortSettings+ -> IOTask ()+serialOpenTask cmdDat resQ serialVar lockTMVar prompts device settings = do+ hPutStrLn stderr $ "[INFO] PMS.Infra.Serial.DS.Core.serialOpenTask start. "+ let waitmicro = 100000+ readsize = 1024+ tout = DM._TIMEOUT_MICROSEC+ promptAdded = prompts ++ ["login:"]+ jsonRpc = cmdDat^.DM.jsonrpcSerialOpenCommandData++ STM.atomically (STM.takeTMVar serialVar) >>= \case+ Just p -> do+ STM.atomically $ STM.putTMVar serialVar $ Just p+ hPutStrLn stderr "[ERROR] PMS.Infrastructure.DS.Core.serialOpenTask: serial is already connected."+ toolsCallResponse resQ (cmdDat^.DM.jsonrpcSerialOpenCommandData) (ExitFailure 1) "" "serial is already running."+ Nothing -> flip E.catchAny errHdl $ do+ hPutStrLn stderr $ "[INFO] PMS.Infra.Serial.DS.Core.serialOpenTask end." ++ (show settings)+ serialhdl <- createSerialPort device settings+ writeSerialPort serialhdl $ BS8.pack $ DM._CR+ CC.threadDelay waitmicro++ STM.atomically $ STM.putTMVar serialVar (Just serialhdl)+ hPutStrLn stderr $ "[INFO] PMS.Infra.Serial.DS.Core.serialOpenTask end. serial connected to " ++ device ++ ":" ++ show settings++ STM.atomically (STM.readTMVar serialVar) >>= \case+ Nothing -> do+ hPutStrLn stderr "[ERROR] PMS.Infra.Serial.DS.Core.serialOpenTask: serial is not started."+ toolsCallResponse resQ jsonRpc (ExitFailure 1) "" "serial is not started."+ Just serialhdl -> do+ race (DM.expect lockTMVar (readSizeSerialPort serialhdl readsize) promptAdded) (CC.threadDelay tout) >>= \case+ Left res -> toolsCallResponse resQ jsonRpc ExitSuccess (maybe "Nothing" id res) ""+ Right _ -> toolsCallResponse resQ jsonRpc (ExitFailure 1) "" "timeout occurred."++ hPutStrLn stderr "[INFO] PMS.Infra.Serial.DS.Core.serialOpenTask end."++ where+ errHdl :: E.SomeException -> IO ()+ errHdl e = do+ STM.atomically $ STM.putTMVar serialVar Nothing+ hPutStrLn stderr $ "[ERROR] PMS.Infra.Serial.DS.Core.serialRunTask: exception occurred. " ++ show e+ toolsCallResponse resQ (cmdDat^.DM.jsonrpcSerialOpenCommandData) (ExitFailure 1) "" (show e)++-- |+--+genSerialCloseTask :: DM.SerialCloseCommandData -> AppContext (IOTask ())+genSerialCloseTask dat = do+ $logDebugS DM._LOGTAG $ T.pack $ "genSerialCloseTask called. "+ serialTMVar <- view handleAppData <$> ask+ resQ <- view DM.responseQueueDomainData <$> lift ask+ return $ serialCloseTask dat resQ serialTMVar++-- |+--+serialCloseTask :: DM.SerialCloseCommandData+ -> STM.TQueue DM.McpResponse+ -> STM.TMVar (Maybe Handle)+ -> IOTask ()+serialCloseTask cmdDat resQ serialTMVar = flip E.catchAny errHdl $ do+ hPutStrLn stderr $ "[INFO] PMS.Infra.Serial.DS.Core.serialCloseTask run. "+ let jsonRpc = cmdDat^.DM.jsonrpcSerialCloseCommandData++ STM.atomically (STM.swapTMVar serialTMVar Nothing) >>= \case+ Nothing -> do+ hPutStrLn stderr "[ERROR] PMS.Infra.Serial.DS.Core.serialCloseTask: serial is not started."+ toolsCallResponse resQ jsonRpc (ExitFailure 1) "" "serial is not started."+ Just serialhdl -> do+ hClose serialhdl+ toolsCallResponse resQ jsonRpc ExitSuccess "" "serial is teminated."+ hPutStrLn stderr $ "[INFO] PMS.Infra.Serial.DS.Core.serialCloseTask closeSerial : "++ hPutStrLn stderr "[INFO] PMS.Infra.Serial.DS.Core.serialCloseTask end."++ where+ -- |+ --+ errHdl :: E.SomeException -> IO ()+ errHdl e = toolsCallResponse resQ (cmdDat^.DM.jsonrpcSerialCloseCommandData) (ExitFailure 1) "" (show e)+++-- |+--+genSerialReadTask :: DM.SerialReadCommandData -> AppContext (IOTask ())+genSerialReadTask cmdData = do+ let argsBS = DM.unRawJsonByteString $ cmdData^.DM.argumentsSerialReadCommandData+ tout = 30 * 1000 * 1000+ resQ <- view DM.responseQueueDomainData <$> lift ask+ serialTMVar <- view handleAppData <$> ask+ argsDat <- liftEither $ eitherDecode $ argsBS+ let size = argsDat^.sizeSerialIntToolParams++ $logDebugS DM._LOGTAG $ T.pack $ "genSerialReadTask: args. " ++ show size+ return $ serialReadTask cmdData resQ serialTMVar size tout++-- |+--+serialReadTask :: DM.SerialReadCommandData+ -> STM.TQueue DM.McpResponse+ -> STM.TMVar (Maybe Handle)+ -> Int -- read size.+ -> Int -- timeout microsec+ -> IOTask ()+serialReadTask cmdDat resQ serialTMVar size tout = flip E.catchAny errHdl $ do+ hPutStrLn stderr $ "[INFO] PMS.Infra.Serial.DS.Core.serialReadTask run. " ++ show size+ + STM.atomically (STM.readTMVar serialTMVar) >>= \case+ Nothing -> do+ hPutStrLn stderr "[ERROR] PMS.Infra.Serial.DS.Core.serialReadTask: serial is not started."+ toolsCallResponse resQ jsonRpc (ExitFailure 1) "" "serial is not started."+ Just p -> go p++ hPutStrLn stderr "[INFO] PMS.Infra.Serial.DS.Core.serialReadTask end."++ where+ jsonRpc :: DM.JsonRpcRequest+ jsonRpc = cmdDat^.DM.jsonrpcSerialReadCommandData++ errHdl :: E.SomeException -> IO ()+ errHdl e = toolsCallResponse resQ jsonRpc (ExitFailure 1) "" (show e)++ go :: Handle -> IO ()+ go serialhdl =+ race (readSizeSerialPort serialhdl size) (CC.threadDelay tout) >>= \case+ Left res -> toolsCallResponse resQ jsonRpc ExitSuccess (bytesToHex res) ""+ Right _ -> toolsCallResponse resQ jsonRpc (ExitFailure 1) "" "timeout occurred."+++-- |+--+genSerialWriteTask :: DM.SerialWriteCommandData -> AppContext (IOTask ())+genSerialWriteTask cmdData = do+ let argsBS = DM.unRawJsonByteString $ cmdData^.DM.argumentsSerialWriteCommandData+ resQ <- view DM.responseQueueDomainData <$> lift ask+ serialTMVar <- view handleAppData <$> ask+ argsDat <- liftEither $ eitherDecode $ argsBS+ let args = argsDat^.dataSerialWord8ArrayToolParams++ $logDebugS DM._LOGTAG $ T.pack $ "genSerialWriteTask: args. " ++ show args+ return $ serialWriteTask cmdData resQ serialTMVar args++-- |+--+serialWriteTask :: DM.SerialWriteCommandData+ -> STM.TQueue DM.McpResponse+ -> STM.TMVar (Maybe Handle)+ -> [Word8]+ -> IOTask ()+serialWriteTask cmdDat resQ serialTMVar args = flip E.catchAny errHdl $ do+ hPutStrLn stderr $ "[INFO] PMS.Infra.Serial.DS.Core.serialWriteTask run. " ++ show args+ + STM.atomically (STM.readTMVar serialTMVar) >>= \case+ Nothing -> do+ hPutStrLn stderr "[ERROR] PMS.Infra.Serial.DS.Core.serialWriteTask: serial is not started."+ toolsCallResponse resQ jsonRpc (ExitFailure 1) "" "serial is not started."+ Just p -> go p++ hPutStrLn stderr "[INFO] PMS.Infra.Serial.DS.Core.serialWriteTask end."++ where+ jsonRpc :: DM.JsonRpcRequest+ jsonRpc = cmdDat^.DM.jsonrpcSerialWriteCommandData++ errHdl :: E.SomeException -> IO ()+ errHdl e = toolsCallResponse resQ jsonRpc (ExitFailure 1) "" (show e)++ go :: Handle -> IO ()+ go serialhdl = do+ let bsDat = B.pack args++ hPutStrLn stderr $ "[INFO] PMS.Infra.Serial.DS.Core.serialWriteTask writeSerial (hex): " ++ bytesToHex bsDat++ writeSerialPort serialhdl bsDat++ toolsCallResponse resQ jsonRpc ExitSuccess ("write data to serial. "++ bytesToHex bsDat) ""+++-- |+--+genSerialMessageTask :: DM.SerialMessageCommandData -> AppContext (IOTask ())+genSerialMessageTask cmdData = do+ let argsBS = DM.unRawJsonByteString $ cmdData^.DM.argumentsSerialMessageCommandData+ tout = DM._TIMEOUT_MICROSEC+ prompts <- view DM.promptsDomainData <$> lift ask+ resQ <- view DM.responseQueueDomainData <$> lift ask+ serialTMVar <- view handleAppData <$> ask+ lockTMVar <- view lockAppData <$> ask+ argsDat <- liftEither $ eitherDecode $ argsBS+ let args = argsDat^.argumentsSerialStringToolParams++ $logDebugS DM._LOGTAG $ T.pack $ "genSerialMessageTask: args. " ++ args+ return $ serialMessageTask cmdData resQ serialTMVar lockTMVar args prompts tout++-- |+--+serialMessageTask :: DM.SerialMessageCommandData+ -> STM.TQueue DM.McpResponse+ -> STM.TMVar (Maybe Handle)+ -> STM.TMVar ()+ -> String -- arguments line+ -> [String] -- prompt list+ -> Int -- timeout microsec+ -> IOTask ()+serialMessageTask cmdDat resQ serialTMVar lockTMVar args prompts tout = flip E.catchAny errHdl $ do+ hPutStrLn stderr $ "[INFO] PMS.Infra.Serial.DS.Core.serialMessageTask run. " ++ args+ + STM.atomically (STM.readTMVar serialTMVar) >>= \case+ Nothing -> do+ hPutStrLn stderr "[ERROR] PMS.Infra.Serial.DS.Core.serialMessageTask: serial is not started."+ toolsCallResponse resQ jsonRpc (ExitFailure 1) "" "serial is not started."+ Just p -> go p++ hPutStrLn stderr "[INFO] PMS.Infra.Serial.DS.Core.serialMessageTask end."++ where+ jsonRpc :: DM.JsonRpcRequest+ jsonRpc = cmdDat^.DM.jsonrpcSerialMessageCommandData++ errHdl :: E.SomeException -> IO ()+ errHdl e = toolsCallResponse resQ jsonRpc (ExitFailure 1) "" (show e)++ go :: Handle -> IO ()+ go serialhdl = do++ msg <- DM.validateMessage args+ let cmd = TE.encodeUtf8 $ T.pack $ msg ++ DM._CR+ waitmicro = 100000+ size = 1024+ hPutStrLn stderr $ "[INFO] PMS.Infra.Serial.DS.Core.serialMessageTask writeSerial : " ++ BS8.unpack cmd++ writeSerialPort serialhdl cmd+ CC.threadDelay waitmicro+ race (DM.expect lockTMVar (readSizeSerialPort serialhdl size) prompts) (CC.threadDelay tout) >>= \case+ Left res -> toolsCallResponse resQ jsonRpc ExitSuccess (maybe "Nothing" id res) ""+ Right _ -> toolsCallResponse resQ jsonRpc (ExitFailure 1) "" "timeout occurred."++
+ src/PMS/Infra/Serial/DS/Utility.hs view
@@ -0,0 +1,129 @@+{-# LANGUAGE OverloadedStrings #-}++module PMS.Infra.Serial.DS.Utility where++import Control.Lens+import System.Exit+import System.IO+import System.Log.FastLogger+import qualified Control.Exception.Safe as E+import Control.Monad.IO.Class+import Control.Monad.Except+import Control.Monad.Reader+import qualified Control.Concurrent.STM as STM+import System.Hardware.Serialport+import qualified Data.ByteString as B+import qualified Data.ByteString.Base16 as B16+import qualified Data.ByteString.Char8 as C8+import qualified Text.Read as R++import qualified PMS.Domain.Model.DM.Type as DM+import qualified PMS.Domain.Model.DS.Utility as DM+import PMS.Infra.Serial.DM.Type++-- |+--+runApp :: DM.DomainData -> AppData -> TimedFastLogger -> AppContext a -> IO (Either DM.ErrorData a)+runApp domDat appDat logger ctx =+ DM.runFastLoggerT domDat logger+ $ runExceptT+ $ flip runReaderT domDat+ $ runReaderT ctx appDat+++-- |+--+liftIOE :: IO a -> AppContext a+liftIOE f = liftIO (go f) >>= liftEither+ where+ go :: IO b -> IO (Either String b)+ go x = E.catchAny (Right <$> x) errHdl++ errHdl :: E.SomeException -> IO (Either String a)+ errHdl = return . Left . show++---------------------------------------------------------------------------------+-- |+--+toolsCallResponse :: STM.TQueue DM.McpResponse+ -> DM.JsonRpcRequest+ -> ExitCode+ -> String+ -> String+ -> IO ()+toolsCallResponse resQ jsonRpc code outStr errStr = do+ let content = [ DM.McpToolsCallResponseResultContent "text" outStr+ , DM.McpToolsCallResponseResultContent "text" errStr+ ]+ result = DM.McpToolsCallResponseResult {+ DM._contentMcpToolsCallResponseResult = content+ , DM._isErrorMcpToolsCallResponseResult = (ExitSuccess /= code)+ }+ resDat = DM.McpToolsCallResponseData jsonRpc result+ res = DM.McpToolsCallResponse resDat++ STM.atomically $ STM.writeTQueue resQ res++-- |+--+errorToolsCallResponse :: String -> AppContext ()+errorToolsCallResponse errStr = do+ jsonRpc <- view jsonrpcAppData <$> ask+ let content = [ DM.McpToolsCallResponseResultContent "text" errStr ]+ result = DM.McpToolsCallResponseResult {+ DM._contentMcpToolsCallResponseResult = content+ , DM._isErrorMcpToolsCallResponseResult = True+ }+ resDat = DM.McpToolsCallResponseData jsonRpc result+ res = DM.McpToolsCallResponse resDat++ resQ <- view DM.responseQueueDomainData <$> lift ask+ liftIOE $ STM.atomically $ STM.writeTQueue resQ res++-- |+-- +bytesToHex :: B.ByteString -> String+bytesToHex = C8.unpack . B16.encode+++-- |+-- +createSerialPort :: FilePath -> SerialPortSettings -> IO Handle+createSerialPort = hOpenSerial++-- |+-- +readSizeSerialPort :: Handle -> Int -> IO B.ByteString+readSizeSerialPort = B.hGetSome++-- |+-- +readLineSerialPort :: Handle -> IO B.ByteString+readLineSerialPort = C8.hGetLine+++-- |+-- +writeSerialPort :: Handle -> B.ByteString -> IO ()+writeSerialPort serialhdl bs = do+ B.hPut serialhdl bs+ hFlush serialhdl++ ++-- |+-- +getCommSpeed :: Int -> AppContext CommSpeed+getCommSpeed n = case R.readMaybe ("CS" ++ show n) of+ Just cs -> return cs+ Nothing -> throwError $ "invalid comm speed: " ++ show n++-- |+-- +getSerialSetting :: Int -> AppContext SerialPortSettings+getSerialSetting speed = do+ cs <- getCommSpeed speed+ return defaultSerialSettings {+ commSpeed = cs+ , timeout = 1+ }
+ test/PMS/Infra/Serial/App/ControlSpec.hs view
@@ -0,0 +1,103 @@+{-# LANGUAGE TemplateHaskell #-}+{-# LANGUAGE OverloadedStrings #-}++module PMS.Infra.Serial.App.ControlSpec (spec) where++import Test.Hspec+import Control.Concurrent.Async+import qualified Control.Concurrent.STM as STM+import Control.Lens+import Data.Default++import qualified PMS.Domain.Model.DM.Type as DM+import qualified PMS.Infra.Serial.App.Control as SUT+import qualified PMS.Infra.Serial.DM.Type as SUT++-- |+--+data SpecContext = SpecContext {+ _domainDataSpecContext :: DM.DomainData+ , _appDataSpecContext :: SUT.AppData+ }++makeLenses ''SpecContext++defaultSpecContext :: IO SpecContext+defaultSpecContext = do+ domDat <- DM.defaultDomainData+ appDat <- SUT.defaultAppData+ return SpecContext {+ _domainDataSpecContext = domDat+ , _appDataSpecContext = appDat+ }++-- |+--+spec :: Spec+spec = do+ runIO $ putStrLn "Start Spec."+ beforeAll setUpOnce $ + afterAll tearDownOnce . + beforeWith setUp . + after tearDown $ run++-- |+--+setUpOnce :: IO SpecContext+setUpOnce = do+ putStrLn "[INFO] EXECUTED ONLY ONCE BEFORE ALL TESTS START."+ defaultSpecContext++-- |+--+tearDownOnce :: SpecContext -> IO ()+tearDownOnce _ = do+ putStrLn "[INFO] EXECUTED ONLY ONCE AFTER ALL TESTS FINISH."++-- |+--+setUp :: SpecContext -> IO SpecContext+setUp ctx = do+ putStrLn "[INFO] EXECUTED BEFORE EACH TEST STARTS."++ domDat <- DM.defaultDomainData+ appDat <- SUT.defaultAppData+ return ctx {+ _domainDataSpecContext = domDat+ , _appDataSpecContext = appDat+ }++-- |+--+tearDown :: SpecContext -> IO ()+tearDown _ = do+ putStrLn "[INFO] EXECUTED AFTER EACH TEST FINISHES."++-- |+--+run :: SpecWith SpecContext+run = do+ describe "runWithAppData" $ do+ context "when echo command issued." $ do+ it "should call callback" $ \ctx -> do + putStrLn "[INFO] EXECUTING THE FIRST TEST."++ let domDat = ctx^.domainDataSpecContext+ appDat = ctx^.appDataSpecContext+ cmdQ = domDat^.DM.serialQueueDomainData+ resQ = domDat^.DM.responseQueueDomainData+ expect = "abc"+ jsonR = def {DM._jsonrpcJsonRpcRequest = expect}+ argDat = DM.SerialEchoCommandData jsonR ""+ args = DM.SerialEchoCommand argDat+ + thId <- async $ SUT.runWithAppData appDat domDat++ STM.atomically $ STM.writeTQueue cmdQ args++ (DM.McpToolsCallResponse dat) <- STM.atomically $ STM.readTQueue resQ++ let actual = dat^.DM.jsonrpcMcpToolsCallResponseData^.DM.jsonrpcJsonRpcRequest+ actual `shouldBe` expect++ cancel thId
+ test/Spec.hs view
@@ -0,0 +1,1 @@+{-# OPTIONS_GHC -F -pgmF hspec-discover #-}