Skip to content

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

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Aug 16, 2018
Merged

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

merged 5 commits into from
Aug 16, 2018

Conversation

kivaisan
Copy link
Contributor

@kivaisan 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
17d02d9 
Also duplicate documentation is removed from LoRaWANInterface which
inherits LoRaWANBase class.
@kivaisan
Copy link
Contributor Author

kivaisan commented Aug 7, 2018

@hasnainvirk, @AnttiKauppila, @kjbracey-arm, please review.

@0xc0170 0xc0170 requested review from a team, kjbracey and AnotherButler August 7, 2018 13:36
AnttiKauppila
AnttiKauppila approved these changes Aug 8, 2018
View reviewed changes
Copy link

@AnttiKauppila AnttiKauppila left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy edit LoraWANBase.h
71341ec 
Copy edit file, mostly for consistent U.S. spelling and precise language.
AnotherButler
AnotherButler reviewed Aug 8, 2018
View reviewed changes
features/lorawan/LoRaWANBase.h Outdated
* @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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
57f89a2 
- Modified "user" to "you"
- Modified line length to ~100 characters.
@kivaisan
Copy link
Contributor Author

kivaisan commented Aug 9, 2018

Please review again

Copy edit LoRaWANBase.h
9e74fa5 
Copy edit file for minor grammar nits.
cmonr
cmonr reviewed Aug 14, 2018
View reviewed changes
Copy link
Contributor

@cmonr cmonr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@cmonr
Copy link
Contributor

cmonr commented Aug 14, 2018

/morph build

Lora: send and receive methods return LORAWAN_STATUS_NOT_INITIALIZED …
aa0c61b 
…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
Copy link
Contributor Author

@hasnainvirk @AnttiKauppila please review again.

@hasnainvirk
Copy link
Contributor

Looks good.

@mbed-ci
Copy link

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
Copy link

mbed-ci commented Aug 14, 2018

Exporter Build : SUCCESS

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

@cmonr
Copy link
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
Copy link

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
Copy link
Contributor

cmonr commented Aug 14, 2018

Strange export build error.

/morph export-build

@mbed-ci
Copy link

mbed-ci commented Aug 14, 2018

Exporter Build : SUCCESS

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

@mbed-ci
Copy link

mbed-ci commented Aug 14, 2018

Exporter Build : SUCCESS

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

@mbed-ci
Copy link

mbed-ci commented Aug 16, 2018

Test : SUCCESS

Build number : 2546
Test logs :http://mbed-os-logs.s3-website-us-west-1.amazonaws.com/?prefix=logs/7719/2546

@AnttiKauppila
Copy link

This can be merged, looks good.

@cmonr cmonr merged commit 4ce0d90 into ARMmbed:master Aug 16, 2018
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…
c935b22 
…_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
Reviewers

@cmonr cmonr cmonr approved these changes

@AnttiKauppila AnttiKauppila AnttiKauppila approved these changes

@AnotherButler AnotherButler AnotherButler approved these changes

@kjbracey kjbracey Awaiting requested review from kjbracey

Assignees
No one assigned
Labels
release-version: 5.9.6
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@kivaisan @cmonr @hasnainvirk @mbed-ci @AnttiKauppila @AnotherButler @0xc0170