Skip to content

Commit 63c7b91

Browse files
author
Fill in your name and e-mail
committed
docs: update Readme
1 parent c0b6a69 commit 63c7b91

File tree

1 file changed

+66
-0
lines changed

1 file changed

+66
-0
lines changed

README.md

+66
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,68 @@
11
# EmbeddedProto_Example_FRDM_CAN_Bootloader
22
Example in which Embedded Proto is used to do CAN net booting on a NXP FRDM-KE06Z
3+
4+
5+
![alt text](https://embeddedproto.com/wp-content/uploads/2022/04/Embedded_Proto.png "Embedded Proto Logo")
6+
7+
8+
Embedded Proto is a product of Embedded AMS B.V. For more information about Embedded Proto please visit [EmbeddedProto.com](https://EmbeddedProto.com).
9+
10+
Copyrights 2020-2024 Embedded AMS B.V. Amsterdam, [www.EmbeddedAMS.nl](https://www.EmbeddedAMS.nl), [[email protected]](mailto:[email protected])
11+
12+
13+
# Introduction
14+
15+
This repository hosts example code for Embedded Proto, the embedded implementation of Google Protocol Buffers.
16+
This is an example showing how the NXP FRDM-KE06Z boots with firmware it receives from a CAN network.
17+
18+
Commands are sent from the PC to a USB to CAN converter which is connected to the FDRM-KE06Z.
19+
20+
You can read the full tutorial [here]().
21+
22+
# Requirements
23+
24+
* [FDRM-KE06Z](https://www.nxp.com/design/design-center/development-boards-and-designs/general-purpose-mcus/freedom-development-platform-for-kinetis-ke06-mcus:FRDM-KE06Z)
25+
* MCUExpresso
26+
* USB to CAN adapter, like [this one](https://openlightlabs.com/collections/frontpage/products/canable-pro-isolated-usb-to-can-adapter)
27+
* Dupont cables
28+
* Embedded Proto version 3.4.1 (included as a submodule). The requirements of Embedded Proto are listed [here](https://github.com/Embedded-AMS/EmbeddedProto/blob/master/README.md).
29+
30+
# Installation
31+
32+
1. Install MCUXpresso if you have not already.
33+
2. Install the dependencies required by Embedded Proto. They are listed [here](https://github.com/Embedded-AMS/EmbeddedProto).
34+
3. Clone the repository and auto generate the protobuf files.
35+
36+
```shell
37+
git clone --recursive https://github.com/Embedded-AMS/EmbeddedProto_Example_FRDM_CAN_Bootloader.git
38+
cd EmbeddedProto_Example_FRDM_CAN_Bootloader
39+
python3 setup.py
40+
```
41+
42+
# Running the code
43+
44+
1. Connect the USB to CAN to the FDRM-KE06Z CAN header.
45+
2. Upload the code to the FRDM-KE06Z using MCUExpresso. The board includes the PE-Micro debugger.
46+
3. Run the following instructions
47+
48+
```shell
49+
cd EmbeddedProto_Example_FRDM_CAN_Bootloader
50+
source desktop/venv/bin/activate
51+
python3 desktop/main.py desktop/assets/frdmke06z_led_blinky_RED.bin
52+
```
53+
54+
Debug information will be shown in the terminal. After the booting is done the led will start blinking RED.
55+
56+
There is another example binary to make the led blink GREEN
57+
```shell
58+
python3 desktop/main.py desktop/assets/frdmke06z_led_blinky_RED.bin
59+
```
60+
61+
Have fun!
62+
63+
---
64+
65+
Three simple things you can do to help improve Embedded Proto:
66+
* Give private [feedback](https://EmbeddedProto.com/feedback).
67+
* Report an issue in public on [Github](https://github.com/Embedded-AMS/EmbeddedProto/issues).
68+
* Stay up to date on Embedded Proto via our [User mailing list](https://EmbeddedProto.com/signup).

0 commit comments

Comments
 (0)