src/app/tests/integration/README.md

   1 # CHIP Example IM Application Tutorial
   2
   3 ## Introduction
   4
   5 The CHIP IM example application shows you how to implement a CHIP application
   6 program using IM protocols.
   7
   8 CHIP Protocols are, essentially, implementations of specific protocols over the
   9 CHIP transport. Furthermore, when two CHIP nodes are exchanging messages of a
  10 particular CHIP protocol, they do so over a construct called a CHIP Exchange
  11 which is a description of a CHIP-based conversation over a CHIP protocol. A CHIP
  12 Exchange is characterised by the ExchangeContext object, and every CHIP node
  13 must create an ExchangeContext object before initiating a CHIP conversation.
  14
  15 After constructing a CHIP ExchangeContext, CHIP messages are sent and received
  16 using the ChipMessageLayer class which sends the CHIP message over a chosen
  17 transport (TCP, UDP, or CRMP).
  18
  19 ## Example Applications Walk Through
  20
  21 As part of this example, we have a ChipImInitiator program that acts as the
  22 client and sends echo requests to a ChipImResponder program that receives
  23 InvokeCommandRequests and sends back InvokeCommandResponse messages.
  24
  25 ### Test a device over IP
  26
  27 To start the Server in echo mode, run the built executable.
  28
  29     $ ./chip-im-responder
  30
  31 To start the Client in echo mode, run the built executable and pass it the IP
  32 address of the server to talk to.
  33
  34     $ ./chip-im-initiator <Server's IPv4 address>
  35
  36 If valid values are supplied, it will begin to periodically send messages to the
  37 server address provided for three times.