Cellular: Documenting the support for Non-IP data delivery feature #928

mirelachirica · 2019-01-22T08:33:26Z

@lauri-piikivi, @AriParkkila please review.

AriParkkila

Need to update cellular configuration docs as well?

AnotherButler · 2019-01-22T19:57:17Z

Thanks for the PR, @mirelachirica
It looks like a code snippet is failing. Could you please look into this?

mirelachirica · 2019-01-23T08:40:54Z

It looks like a code snippet is failing. Could you please look into this?

I have commited one change I think will fix the problem. Where to find the relevant scripts to verify these changes locally? thanks!

mirelachirica · 2019-01-23T10:52:21Z

Need to update cellular configuration docs as well?

I updated it.

AnotherButler · 2019-01-23T22:08:50Z

@mirelachirica Thanks 👍 It's all passing now.

You can find the files here: https://github.com/ARMmbed/mbed-os-5-docs/blob/development/.travis.yml and https://github.com/ARMmbed/mbed-os-5-docs/blob/development/check_tools/find_bad_code_snippets.sh

AnotherButler · 2019-01-23T22:09:13Z

@lauri-piikivi Is this ready to merge?

lauri-piikivi

I just wanted to remove some of the scary words and acronyms, otherwise I think it was very good!

docs/api/networksocket/CellularNonIPSocket.md

docs/reference/technology/connectivity/connectivity.md

mirelachirica · 2019-02-05T07:32:05Z

Closed by accident

mirelachirica · 2019-02-05T07:34:38Z

@lauri-piikivi is this ok as it is?

AnotherButler · 2019-02-05T21:27:50Z

Code dependency: ARMmbed/mbed-os#9568

mirelachirica · 2019-02-12T07:51:06Z

The NIDD suport is now in master, introduced by feature-cellular-refactor merge to master:
ARMmbed/mbed-os@8c2ad14

AnotherButler · 2019-02-12T22:17:54Z

@lauri-piikivi Have your concerns been addressed?

Edit file, mostly for minor style change and international English (as opposed to UK English).

AnotherButler · 2019-02-13T22:28:21Z

docs/api/networksocket/CellularNonIPSocket.md

+
+[`CellularContext`](https://os.mbed.com/docs/development/mbed-os-api-doxy/_cellular_context_8h.html) sets up the modem into the Control Plane optimization mode of operation if it is requested and if the cellular network supports it.
+
+Control plane optimization is a new feature for cellular IoT (CIoT). With it, the device can use cellular control channels for data communications, to save power and resources. It does this by using less radio singling.


Is "radio singling" correct, or is it "radio signaling"?

signaling is the correct term

About the rephrasing. Is it clear that "this" in "It does this by using" refers to saving power and resources?

No, it's not clear. Good catch. What do you think about "...to save power and resources by using less radio signaling."?

Sounds good!

AnotherButler

Please answer the question I left and review my changes to make sure I didn't accidentally change the meaning of anything.

Edit file for consistent capitalization across docs.

Make minor edits to add a missing space and standardize capitalization in headings throughout the document.

mirelachirica · 2019-02-14T10:26:14Z

docs/api/networksocket/networksocket.md

@@ -97,7 +97,7 @@ The network socket API provides a common interface for using sockets on network
 - [UDPSocket](udpsocket.html): This class provides the ability to send packets of data over UDP.
 - [TCPSocket](tcpsocket.html): This class provides the ability to send a stream of data over TCP.
 - [SocketAddress](socketaddress.html): You can use this class to represent the IP address and port pair of a unique network endpoint.
- [CellularNonIPSocket](cellularnonipsocket.html): This class provides the ability to send and receive 3GPP Non-IP datagrams (NIDD) using Cellular IoT feature.
+- [CellularNonIPSocket](cellularnonipsocket.html): This class provides the ability to send and receive 3GPP non-IP datagrams (NIDD) using our cellular IoT feature.


Cellular -> cellular is fine but "our" I dont think so. It was meant as IoT feature for cellular networks, so a cellluar IoT feature not mbed cellular IoT feature.

Thanks for explaining. Would "...using the cellular IoT feature." be better?

mirelachirica · 2019-02-14T10:30:04Z

docs/api/networksocket/CellularNonIPSocket.md

+
+[`CellularContext`](https://os.mbed.com/docs/development/mbed-os-api-doxy/_cellular_context_8h.html) sets up the modem into the Control Plane optimization mode of operation if it is requested and if the cellular network supports it.
+
+Control plane optimization is a new feature for cellular IoT (CIoT). With it, the device can use cellular control channels for data communications, to save power and resources. It does this by using less radio singling.


signaling is the correct term

mirelachirica · 2019-02-14T10:31:59Z

docs/api/networksocket/CellularNonIPSocket.md

+
+[`CellularContext`](https://os.mbed.com/docs/development/mbed-os-api-doxy/_cellular_context_8h.html) sets up the modem into the Control Plane optimization mode of operation if it is requested and if the cellular network supports it.
+
+Control plane optimization is a new feature for cellular IoT (CIoT). With it, the device can use cellular control channels for data communications, to save power and resources. It does this by using less radio singling.


About the rephrasing. Is it clear that "this" in "It does this by using" refers to saving power and resources?

Make change suggested in comments.

Make change suggested in comments for accuracy.

AnotherButler · 2019-02-19T16:32:04Z

To clarify, this is only for 5.12, right? Not for 5.11?

mirelachirica · 2019-02-20T08:28:40Z

To clarify, this is only for 5.12, right? Not for 5.11?
Yes, for 5.12 only.

AnotherButler · 2019-02-20T16:04:03Z

@lauri-piikivi I'm going to merge this. If you have any further changes, please raise them in a new PR.

AriParkkila approved these changes Jan 22, 2019

View reviewed changes

AnotherButler requested a review from lauri-piikivi January 22, 2019 19:55

mirelachirica force-pushed the nonip branch from 08af067 to 454a356 Compare January 23, 2019 08:32

mirelachirica force-pushed the nonip branch from 454a356 to 1823cc7 Compare January 23, 2019 10:21

lauri-piikivi suggested changes Jan 31, 2019

View reviewed changes

Cellular: Documenting the support for Non-IP data delivery feature

fac2771

mirelachirica force-pushed the nonip branch from 1823cc7 to fac2771 Compare January 31, 2019 11:28

mirelachirica closed this Feb 4, 2019

mirelachirica reopened this Feb 5, 2019

AnotherButler added the code dependency label Feb 5, 2019

Edit CellularNonIPSocket.md

38ecd70

Edit file, mostly for minor style change and international English (as opposed to UK English).

AnotherButler reviewed Feb 13, 2019

View reviewed changes

Amanda Butler added 2 commits February 13, 2019 16:37

Edit networksocket.md

3ec8229

Edit file for consistent capitalization across docs.

Edit connectivity.md

56ef0f2

Make minor edits to add a missing space and standardize capitalization in headings throughout the document.

mirelachirica commented Feb 14, 2019

View reviewed changes

Amanda Butler added 2 commits February 19, 2019 10:30

Update CellularNonIPSocket.md

b678536

Make change suggested in comments.

Update networksocket.md

303292f

Make change suggested in comments for accuracy.

AnotherButler removed the code dependency label Feb 19, 2019

AnotherButler merged commit ca1989b into ARMmbed:development Feb 20, 2019


		[`CellularContext`](https://os.mbed.com/docs/development/mbed-os-api-doxy/_cellular_context_8h.html) sets up the modem into the Control Plane optimization mode of operation if it is requested and if the cellular network supports it.

		Control plane optimization is a new feature for cellular IoT (CIoT). With it, the device can use cellular control channels for data communications, to save power and resources. It does this by using less radio singling.

Cellular: Documenting the support for Non-IP data delivery feature #928

Cellular: Documenting the support for Non-IP data delivery feature #928

Uh oh!

Conversation

mirelachirica commented Jan 22, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AriParkkila left a comment

Choose a reason for hiding this comment

Uh oh!

AnotherButler commented Jan 22, 2019

Uh oh!

mirelachirica commented Jan 23, 2019

Uh oh!

mirelachirica commented Jan 23, 2019

Uh oh!

AnotherButler commented Jan 23, 2019

Uh oh!

AnotherButler commented Jan 23, 2019

Uh oh!

lauri-piikivi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mirelachirica commented Feb 5, 2019

Uh oh!

mirelachirica commented Feb 5, 2019

Uh oh!

AnotherButler commented Feb 5, 2019

Uh oh!

mirelachirica commented Feb 12, 2019

Uh oh!

AnotherButler commented Feb 12, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AnotherButler left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AnotherButler commented Feb 19, 2019

Uh oh!

mirelachirica commented Feb 20, 2019

Uh oh!

AnotherButler commented Feb 20, 2019

Uh oh!

Uh oh!

mirelachirica commented Jan 22, 2019 •

edited

Loading