Skip to content

porting update #435

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

Merged
merged 8 commits into from Mar 12, 2018
Merged

porting update #435

merged 8 commits into from Mar 12, 2018

Conversation

ghost
Copy link

@ghost ghost commented Mar 6, 2018

No description provided.

@ghost
Copy link
Author

ghost commented Mar 6, 2018

@AnotherButler @AnttiKauppila please review

Amanda Butler added 2 commits March 6, 2018 15:17
Copy edit file, mostly for active voice, branding and correct image links.
Update heading names and titles to better match template.

- If the modem is already ready to use via the UART, it may be possible to use `UARTCellularInterface` directly. Just pass its constructor the necessary pin information for the module connected to your board.
You must define all pins. Implement `onboard_modem_api.h`. The target board must provide an implementation of the [onboard_modem_API](https://github.com/ARMmbed/mbed-os/blob/master/features/netsocket/cellular/onboard_modem_api.h). Please see the [example implementation ](https://github.com/ARMmbed/mbed-os/blob/master/targets/TARGET_NXP/TARGET_LPC176X/TARGET_UBLOX_C027/onboard_modem_api.c).
Copy link
Contributor

Choose a reason for hiding this comment

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

We don't like to link to GitHub, so we need to find all of the GitHub links in the Doxygen once it's generated.


- If using a different connection type, you must provide access to the connection by implementing the `FileHandle` API, and then you can pass your file handle for that connection to `PPPCellularInterface`. Either use it directly, or derive from it, and pass a file handle to its constructor in the same manner as `UARTCellularInterface`.
Setup for some predefined targets is available in [CellularTargets.h](https://github.com/ARMmbed/mbed-os/blob/master/features/cellular/framework/common/CellularTargets.h). For a new target, you need to modify `CellularTargets.h`. In `CellularTargets.h`, you need to specify a cellular device in addition to UART pins connecting the Mbed OS CPU to the modem. For example, if you used a K64F to connect with the QUECTEL BG96, you need the following changes marked in between `// !!!!` in `CellularTargets.h`:
Copy link
Contributor

Choose a reason for hiding this comment

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

Query: Is there a reason we chose the K64F? Also, can we use a real example that's not board-specific?

@AnotherButler AnotherButler merged commit 18e7c72 into ARMmbed:new_engine Mar 12, 2018
@ghost ghost deleted the porting_guide branch March 28, 2018 10:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant