New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lora: Document all possible error codes for LoRaWANBase methods #7719

Merged
merged 5 commits into from Aug 16, 2018

Conversation

Projects
None yet
7 participants
@kivaisan
Contributor

kivaisan commented Aug 7, 2018

Description

Document all possible error codes for LoRaWANBase methods.

Also duplicate documentation is removed from LoRaWANInterface which
inherits LoRaWANBase class.

Pull request type

[X] Fix
[ ] Refactor
[ ] Target update
[ ] Feature
[ ] Breaking change
Lora: Document all possible error codes for LoRaWANBase methods
Also duplicate documentation is removed from LoRaWANInterface which
inherits LoRaWANBase class.
@kivaisan

This comment has been minimized.

Contributor

kivaisan commented Aug 7, 2018

@0xc0170 0xc0170 requested review from ARMmbed/mbed-os-wan, kjbracey-arm and AnotherButler Aug 7, 2018

@AnttiKauppila

LGTM

Copy edit LoraWANBase.h
Copy edit file, mostly for consistent U.S. spelling and precise language.
* @return For ABP: If everything goes well, LORAWAN_STATUS_OK is returned for first call followed by
/** Connect OTAA or ABP with parameters
*
* All connection parameters are chosen by the user and provided in the

This comment has been minimized.

@AnotherButler

AnotherButler Aug 8, 2018

Contributor

Note: Sometimes we say "you," and sometimes we say "the user". If the reader is the user, it should always be "you". If the reader's not the user, who is the reader?

Lora: Reformate LoRaWANBase documentation
- Modified "user" to "you"
- Modified line length to ~100 characters.
@kivaisan

This comment has been minimized.

Contributor

kivaisan commented Aug 9, 2018

Please review again

Copy edit LoRaWANBase.h
Copy edit file for minor grammar nits.
@cmonr

This comment has been minimized.

Contributor

cmonr commented Aug 14, 2018

/morph build

Lora: send and receive methods return LORAWAN_STATUS_NOT_INITIALIZED …
…if not initialized

In order have a consistent return value for all methods in case of system is uninitialized
now also send and receive methods can return LORAWAN_STATUS_NOT_INITIALIZED.
@kivaisan

This comment has been minimized.

Contributor

kivaisan commented Aug 14, 2018

@hasnainvirk @AnttiKauppila please review again.

@hasnainvirk

This comment has been minimized.

Contributor

hasnainvirk commented Aug 14, 2018

Looks good.

@mbed-ci

This comment has been minimized.

mbed-ci commented Aug 14, 2018

Build : SUCCESS

Build number : 2803
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/7719/

Triggering tests

/morph test
/morph uvisor-test
/morph export-build
/morph mbed2-build

@mbed-ci

This comment has been minimized.

@cmonr cmonr added needs: review and removed needs: CI labels Aug 14, 2018

@cmonr

cmonr approved these changes Aug 14, 2018

@cmonr cmonr added needs: CI and removed needs: review labels Aug 14, 2018

@cmonr

This comment has been minimized.

Contributor

cmonr commented Aug 14, 2018

Good small change. @AnttiKauppila, a small PR update, if you would like to re-review.

/morph build

@mbed-ci

This comment has been minimized.

mbed-ci commented Aug 14, 2018

Build : SUCCESS

Build number : 2811
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/7719/

Triggering tests

/morph test
/morph uvisor-test
/morph export-build
/morph mbed2-build

@cmonr

This comment has been minimized.

Contributor

cmonr commented Aug 14, 2018

Strange export build error.

/morph export-build

@mbed-ci

This comment has been minimized.

@mbed-ci

This comment has been minimized.

mbed-ci commented Aug 14, 2018

@mbed-ci

This comment has been minimized.

@cmonr cmonr added ready for merge and removed needs: CI labels Aug 16, 2018

@AnttiKauppila

This comment has been minimized.

Contributor

AnttiKauppila commented Aug 16, 2018

This can be merged, looks good.

@cmonr cmonr merged commit 4ce0d90 into ARMmbed:master Aug 16, 2018

14 checks passed

AWS-CI uVisor Build & Test Success
Details
ci-morph-build build completed
Details
ci-morph-exporter build completed
Details
ci-morph-mbed2-build build completed
Details
ci-morph-test test completed
Details
continuous-integration/jenkins/pr-head This commit looks good
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
travis-ci/astyle Passed, 583 files
Details
travis-ci/docs Local docs testing has passed
Details
travis-ci/events Passed, runtime is 9005 cycles (-1549 cycles)
Details
travis-ci/gitattributestest Local gitattributestest testing has passed
Details
travis-ci/licence_check Local licence_check testing has passed
Details
travis-ci/littlefs Passed, code size is 9960B (+0.00%)
Details
travis-ci/tools-py2.7 Local tools-py2.7 testing has passed
Details

pan- pushed a commit to pan-/mbed that referenced this pull request Aug 22, 2018

Merge pull request ARMmbed#7719 from kivaisan/document_lorawan_return…
…_values

Lora: Document all possible error codes for LoRaWANBase methods
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment