From 7791e53454a7e8f2b1275fd53c30c93e24f5dc50 Mon Sep 17 00:00:00 2001 From: Jesus Fuentes Date: Wed, 28 Feb 2018 07:30:18 -0600 Subject: [PATCH] Fix found typos Fix found typos in the documentation -Jesus --- documentation/extensions/iot.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/documentation/extensions/iot.md b/documentation/extensions/iot.md index 6955cafe9..23bf4650e 100644 --- a/documentation/extensions/iot.md +++ b/documentation/extensions/iot.md @@ -1,7 +1,7 @@ Internet of Things (XEP-0323, -0324, -0325, -0347) ================================================== -The Internet of Things (IoT) XEPs are an experimental open standard how XMPP can be used for IoT. They currently consists of +The Internet of Things (IoT) XEPs are an experimental open standard on how XMPP can be used for IoT. They currently consist of - XEP-0323 Sensor Data - XEP-0324 Provisioning - XEP-0325 Control @@ -13,7 +13,7 @@ Smack only supports a subset of the functionality described by the XEPs! Thing Builder ------------- -The `org.jivesoftware.smackx.iot.Thing` class acts as basic entity representing a single "Thing" which can used to retrieve data from or to send control commands to. `Things` are constructed using a builder API. +The `org.jivesoftware.smackx.iot.Thing` class acts as basic entity representing a single "Thing" which can be used to retrieve data from or to send control commands to. `Things` are constructed using a builder API. Reading data from things @@ -32,9 +32,9 @@ Thing dataThing = Thing.builder().setKey(key).setSerialNumber(sn).setMomentaryRe }).build(); ``` -While not strictly required, most things are identified via a key and serial number. We also build the thing with a "momentary read out request handler" which when triggered, retrieved the current temperature and reports it back to the requestor. +While not strictly required, most things are identified via a key and serial number. We also build the thing with a "momentary read out request handler" which when triggered, retrieves the current temperature and reports it back to the requestor. -After the `Thing` is build, it needs to be made available so that other entities within the federated XMPP network can use it. Right now, we only intall the Thing in the `IoTDataManager`, which means the thing will act on read out requests but not be managed by a provisioning server. +After the `Thing` is built, it needs to be made available so that other entities within the federated XMPP network can use it. Right now we only install the Thing in the `IoTDataManager`, which means the thing will act on read out requests but not be managed by a provisioning server. ```java IoTDataManager iotDataManager = IoTDataManager.getInstanceFor(connection); @@ -53,7 +53,7 @@ Now you have to unwrap the `IoTDataField` instances from the `IoTFieldsExtension Controlling a thing ------------------- -Things can also be controlled, e.g. to turn on a light. Let's create thing which can be used to turn the light on and off. +Things can also be controlled, e.g. to turn on a light. Let's create a thing which can be used to turn the light on and off. ```java Thing controlThing = Thing.builder().setKey(key).setSerialNumber(sn).setControlRequestHandler(new ThingControlRequest() { @@ -69,7 +69,7 @@ Thing controlThing = Thing.builder().setKey(key).setSerialNumber(sn).setControlR }).build(); ``` -No we have to install this thing into the `IoTControlManager`: +Now we have to install this thing into the `IoTControlManager`: ```java IoTControlManager iotControlManager = IoTControlManager.getInstanceFor(connection); @@ -89,9 +89,9 @@ Smack currently only supports a subset of the possible data types for set data. Discovery --------- -You may wondered how a full JIDs of things can be determined. One approach is using the discovery mechanisms specified in XEP-0347. Smack provides the `IoTDiscoveryManager` as API for this. +You may have wondered how a full JIDs of things can be determined. One approach is using the discovery mechanisms specified in XEP-0347. Smack provides the `IoTDiscoveryManager` as an API for this. -For example, instead of just installing the previous things in the `IoTDataManager` and/or `IoTControlManager`, we could also use the `IoTDiscoveryManger` to register the thing with a registry. Doing thing also installs the thing in the `IoTDataManager` and the `IoTControlManager`. +For example, instead of just installing the previous things in the `IoTDataManager` and/or `IoTControlManager`, we could also use the `IoTDiscoveryManger` to register the thing with a registry. Doing this also installs the thing in the `IoTDataManager` and the `IoTControlManager`. ```java IoTDiscoveryManager iotDiscoveryManager = IoTDiscoveryManager.getInstanceFor(connection); @@ -105,7 +105,7 @@ The `IoTDiscoveryManager` can also be used to claim, disown, remove and unregist Provisioning ------------ -Things can usually only be used by other things if they are friends. Since a thing normally can't decide on its own if an incoming friendship request should be granted or not, we can delegate this decission to a provisioning service. Smack provides the `IoTProvisinoManager` to deal with friendship and provisioning. +Things can usually only be used by other things if they are friends. Since a thing normally can't decide on its own if an incoming friendship request should be granted or not, we can delegate this decision to a provisioning service. Smack provides the `IoTProvisinoManager` to deal with friendship and provisioning. For example, if you want to befriend another thing: