{"id":1673,"date":"2014-01-13T11:55:51","date_gmt":"2014-01-13T10:55:51","guid":{"rendered":"http:\/\/www.objectis-software.com\/support\/?p=1673"},"modified":"2021-01-26T10:51:37","modified_gmt":"2021-01-26T09:51:37","slug":"ocf-client-cheat-sheet","status":"publish","type":"post","link":"https:\/\/www.objectis-software.com\/support\/ocf-client-cheat-sheet\/","title":{"rendered":"Ocf Client (OcfApiClient)’s cheat sheet"},"content":{"rendered":"\n

Welcome on the Ocf Client (Ocf Api)’s Cheat Sheet. This post will help you to get started Ocf Client.<\/p>\n\n\n\n

You can also get the PDF here<\/a>.<\/p>\n\n\n\n

Here is the contents:<\/p>\n\n\n\n

  1. Ocf Clients for Embedded\n
      \n
    1. Create a client for embedded system (UDP)<\/li>\n
    2. Create a client for embedded system (COM)<\/li>\n<\/ol>\n<\/li>
    3. Ocf Clients for .NET\n
        \n
      1. Create a native client for .NET application<\/li>\n
      2. Create a secure native client for .NET application (communication with AES encryption)<\/li>\n<\/ol>\n<\/li>
      3. Ocf Clients for ADS PLC\n
          \n
        1. Create an ADS client for PLC application<\/li>\n<\/ol>\n<\/li>
        2. Retrieve data thanks to Ocf<\/li>
        3. Register the licenses<\/li><\/ol>\n\n\n\n

          Let’s begin!<\/p>\n\n\n\n

          Ocf Clients for Embedded<\/h2>\n\n\n\n

          Create a client for embedded system (UDP)<\/h3>\n\n\n\n
          \nPrototype : \npublic static dynamic CreateOcfEmbeddedUdpClient(\u000bstring hostName, int port, int timeout);\n\nSample : \ndynamic client = OcfApi.CreateOcfWcfClient(\u000b"127.0.0.1", 10000, 200);\n<\/pre><\/pre>\n\n\n\n
          Create a client for embedded system (COM)<\/h3>\n\n\n\n
          \nPrototype : \npublic static dynamic CreateOcfEmbeddedComClient(\u000bstring portName, SerialDataBaudRate rate, int timeout, SerialDataLength length = SerialDataLength.DL8, Handshake handShake = Handshake.None, Parity parity = Parity.None,  StopBits stopBits = StopBits.One);\n\nSample : \ndynamic client = OcfApi.CreateOcfEmbeddedComClient("COM5", SerialDataBaudRate.BR19200, 1000);\n<\/pre><\/pre>\n\n\n\n
          Ocf Clients for .NET<\/h2>\n\n\n\n
          Create a native client for .NET application<\/h3>\n\n\n\n
          \nPrototype (Udp) :\npublic static dynamic CreateOcfNativeUdpClient(string\nhostName, int port, int timeout);\n\nPrototype (Tcp) :\npublic static dynamic CreateOcfNativeTcpClient(string\nhostName, int port, int timeout);\n<\/pre><\/pre>\n\n\n\n
          Create a secure native client for .NET application (communication with AES encryption)<\/h3>\n\n\n\n
          \nPrototype (Udp) :\npublic static dynamic CreateOcfNativeUdpEncryptedClient(\nstring hostName, int port, string passphrase, int timeout);\n\nPrototype (Tcp) :\npublic static dynamic CreateOcfNativeTcpEncryptedClient(\nstring hostName, int port, string passphrase, int timeout);\n<\/pre><\/pre>\n\n\n\n
          Ocf Clients for ADS PLC<\/h2>\n\n\n\n
          Create an ADS client for PLC application<\/h3>\n\n\n\n
          \nPrototype (ADS) :\npublic static dynamic CreateOcfAdsClient(string netId, int port, int timeout = DefaultTimeOut);\n\nSample :\ndynamic client = OcfApi. CreateOcfAdsClient(\u000b   "192.168.10.12.1.1", 801);\n<\/pre><\/pre>\n\n\n\n
          Retrieve data thanks to Ocf<\/h2>\n\n\n\n
          Get a child of the remote object model<\/p>\n\n\n\n
          \ndynamic axisX = client.Robot.AxisX;\n<\/pre><\/pre>\n\n\n\n
          Reach a property of the remote object model<\/p>\n\n\n\n
          \nIn C#:\nConsole.WriteLine("AxisX :", client.Robot.AxisX.Position);\nclient.Robot.AxisX.Position = 100;\n\nIn Xaml :\n&amp;amp;lt;GroupBox Header="{Binding Client.Name}" Margin="5"&amp;gt;\n<\/pre><\/pre>\n\n\n\n
          Invoke a method of the remote object model<\/p>\n\n\n\n
          \nclient.PowerEnable();\n<\/pre><\/pre>\n\n\n\n
          Manage communication errors with Ocf<\/p>\n\n\n\n
          \nDefine handler on unhandled exceptions :\nApplication.Current.DispatcherUnhandledException +=   CurrentDispatcherUnhandledException;\n\nManage OcfException globally :\nprivate void CurrentDomainUnhandledException(object sender, UnhandledExceptionEventArgs e)\n{\nif (e.Exception is OcfException)\nShowException(e.Exception as Exception);\n}\n<\/pre><\/pre>\n\n\n\n
          Register the licenses<\/h2>\n\n\n\n
          Register a license to create a server\/client Ocf<\/p>\n\n\n\n
          \nPrototype :\npublic static void RegisterLicense(\u000bstring companyName, string key)\n\nSample :\nOcfApi.RegisterLicense("CompanyName", "XXXX-XXXX-XXXX-XXXX");\n<\/pre><\/pre>\n\n\n
          Share this...<\/span>\"Share
          Facebook<\/div><\/a>\"Share
          Pinterest<\/div><\/a>\"Share
          Twitter<\/div><\/a>\"Share
          Linkedin<\/div><\/a><\/div><\/div>\n","protected":false},"excerpt":{"rendered":"
          Welcome on the Ocf Client (Ocf Api)’s Cheat Sheet. This post will help you to get started Ocf Client. You can also get the PDF here. Here is the contents: Ocf Clients for Embedded Create a client for embedded system (UDP) Create a client for embedded system (COM) Ocf Clients for .NET Create a native client for .NET application Create a secure native client for .NET application (communication with AES encryption) Ocf Clients for ADS PLC Create an ADS client for PLC application Retrieve data thanks to Ocf Register the licenses Let’s begin! Ocf Clients for Embedded Create a client Read more<\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[40],"tags":[46,21,53,25,45,48,36],"_links":{"self":[{"href":"https:\/\/www.objectis-software.com\/support\/wp-json\/wp\/v2\/posts\/1673"}],"collection":[{"href":"https:\/\/www.objectis-software.com\/support\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.objectis-software.com\/support\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.objectis-software.com\/support\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.objectis-software.com\/support\/wp-json\/wp\/v2\/comments?post=1673"}],"version-history":[{"count":67,"href":"https:\/\/www.objectis-software.com\/support\/wp-json\/wp\/v2\/posts\/1673\/revisions"}],"predecessor-version":[{"id":2078,"href":"https:\/\/www.objectis-software.com\/support\/wp-json\/wp\/v2\/posts\/1673\/revisions\/2078"}],"wp:attachment":[{"href":"https:\/\/www.objectis-software.com\/support\/wp-json\/wp\/v2\/media?parent=1673"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.objectis-software.com\/support\/wp-json\/wp\/v2\/categories?post=1673"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.objectis-software.com\/support\/wp-json\/wp\/v2\/tags?post=1673"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}