particle-iot / spark-setup-ios

(DEPRECATED) Spark device setup library - Soft AP Cocoapod/Carthage lib for iOS
Apache License 2.0
19 stars 25 forks source link

Document soft AP device command flow #20

Open idokleinman opened 9 years ago

idokleinman commented 9 years ago

From @towynlin on January 15, 2015 5:42

I'm imagining this to simply be a code comment somewhere, but it could be in the README or another piece of documentation. It would help newcomers to the code get oriented if there were a list of the typical flow through soft AP in terms of the commands issued to the device.

From a conversation with @idokleinman, here's the current state of things:

device-id -> public-key -> set -> scan-ap -> configure-ap -> connect-ap

Copied from original issue: spark/mobile-sdk-ios#41

idokleinman commented 9 years ago

Actually there's lots of internal code flow that happens in Soft AP, also in SDK. I am not sure README is a suitable place for documenting that. I can add few lines to the header or implementation file of SparkSetupCommManager class probably