AwaLWM2M icon indicating copy to clipboard operation
AwaLWM2M copied to clipboard

Add top-level sequence diagrams

Open DavidAntliff opened this issue 9 years ago • 4 comments

It would be useful to illustrate information flow via the API with some sequence diagrams. For example:

  • Client-side "set" operation
  • Server-side "read" operation
  • Server-side "observe" operation

DavidAntliff avatar May 27 '16 03:05 DavidAntliff

Affects 0.1.9.

DavidAntliff avatar May 27 '16 04:05 DavidAntliff

@TonyWalsworthImg - does this look like what we would need for a sequence diagram for the Client-side "set" operation?

image

These sequence diagrams could go under the user guide, as an explanation of how the API works? or perhaps in the developer guide as an explanation of the architecture for Awa development?

seank-img avatar Jul 13 '16 03:07 seank-img

This looks good – yes. Except that ‘AwaError_Sucess’ should have double c.

TonyWalsworthImg avatar Jul 13 '16 03:07 TonyWalsworthImg

Is it worth adding the EstablishNotify message after Connect Request Message? Or maybe that's best left for Subscribe/Observe examples.

Also, you can probably just call it "Connect Request" and "Connect Response" rather than "Connect Request Message", as the word "Message" isn't used anywhere else.

DavidAntliff avatar Jul 13 '16 03:07 DavidAntliff