wgtdkp
commented
3 years ago Hi, the commissioner_app.(cpp|hpp) in src/app is actually serving such example, through it provides both 1.1 & 1.2 functions and may not be easy to follow. One important fact is that, the commissioner library doesn't store data (user data like joiner list, network data like Active Dataset) and just process user commands. The CommissionerApp is an example of how a Thread Commissioner App may use the commissioner library and maintain data.
For the simple hello world example, you need to
- create a
Commissionerinstance with aCommissionerHandlerinstance. The commissioner handler is where we receive commissioner/joiner events (e.g. a joiner is requesting joining).
class MyCommissionerHandler : public ot::Commissioner::CommissionerHandler { public: bool OnJoinerFinalize(const ByteArray & aJoinerId, const std::string &aVendorName, const std::string &aVendorModel, const std::string &aVendorSwVersion, const ByteArray & aVendorStackVersion, const std::string &aProvisioningUrl, const ByteArray & aVendorData) override { printf("a joiner from %s is commissioned\n", aVendorName.c_str()); return true; } };
MyCommissionerHandler myHandler; auto commissioner = ot::Commissioner::Commissioner::Create(myHandler);
2. Initialize the commissioner instance with proper configuration:
```c++
ot::Commissioner::Config config;
config.mEnableCcm = false;
config.mPskc = {}; // Set this to your pskc, you can get it with the `pskc` command on a OT CLI node.
commissioner->Init(config);- Petition to be the active commissioner:
std::string existingCommissionerId; commissioner->Petition(existingCommissionerId, <your-BR-address>, <your-BR-port>);
// Check if we succed. printf("the commissioner is active: %s\n", commissioner->IsActive() ? "true" : "false");
4. Enable MeshCop for all joiners:
```c++
ot::Commissioner::CommissionerDataset dataset;
dataset.mPresentFlags |= ot::Commissioner::CommissionerDataset::kSteeringDataBit;
dataset.mSteeringData = {0xFF}; // Set the steeering data to all-ones to allow all joiners.
commissioner->SetCommissionerDataset(dataset);- Loop:
while (true) { sleep(1); }We don't need to run an event loop because the commissioner takes care of it in a background thread. The client just need to keep the commissioner instance from destroyed.
Please note that most those commissioner APIs return an Error and you need to make sure that it's Error::kNone before you can process with the next API. You can find more details of using those APIs in src/app/commissioner_app.cpp by search the API name. Hope this can help.
krbvroc1
Are there any examples or guidelines for using the library? I cannot find any documentation at all.
My goal is to create a commissioner application that has some slight modifications from what ot-commissioner provides but non-interactive. I am not really sure where to start. It does not help that I am a C programmer, not C++. Even a simple 'hello world' example that starts the commissioner, performs an enableall meshcop, adds a custom 'On Join' handler so an application can accept/reject, and runs in whatever event loop is required for the example to continuing running until killed.
Thank you!