Zoul: Updated READMEs

This commit is contained in:
Antonio Lignan 2016-09-01 16:45:16 +02:00
parent e25a62997d
commit 3e5b5dca12
2 changed files with 65 additions and 4 deletions

View file

@ -0,0 +1,59 @@
Zolertia Zoul test examples
============================================
The following tests are valid for the following platforms:
* RE-Mote revision A
* RE-Mote revision B
* Firefly
Specific RE-mote revision A examples are available at the `rev-a` folder.
Compile and install an example
-------------------
To flash either hardware platform use the same `TARGET=zoul` and the following:
* RE-Mote revision A : `BOARD=remote-reva`
* RE-Mote revision B : `BOARD=remote-revb`
* Zolertia Firefly : `BOARD=firefly`
An example on how to compile is shown next:
`make TARGET=zoul BOARD=remote-revb`
Or alternatively if you just type `make`, it will default to use the `BOARD=remote-revb`.
For backward compatibility with the previous `remote` target corresponding to the
RE-Mote revision A, using `BOARD=remote` will default to `BOARD=remote-reva`.
To upload an example to your Zolertia device, just add the `.upload` target as:
`make TARGET=zoul BOARD=remote-revb zoul-demo.upload`
Optionally you can select a specific USB port to flash a given device, in Linux
and assuming there is a device at the `/dev/ttyUSB0`:
`make TARGET=zoul BOARD=remote-revb zoul-demo.upload PORT=/dev/ttyUSB0`
If you ommit the `PORT` argument, the system will flash all Zolertia devices connected over USB.
Visualize the console output
-------------------
Just type `make login` to open a connection to the console via USB.
As above to specify a given port use the `PORT=/dev/ttyUSB0` argument.
Alternatively you can save the above `PORT`, `TARGET` or `BOARD` as follows:
`export BOARD=/dev/ttyUSB0`
This will save you to type these when running a command on the terminal
Documentation and guides
-------------------
More information about the platforms, guides and specific documentation can be found at [Zolertia Wiki][wiki]
[wiki]: https://github.com/Zolertia/Resources/wiki "Zolertia Wiki"

View file

@ -252,10 +252,11 @@ If you prefer this guide in other formats, use the excellent [pandoc] to convert
More Reading
============
1. [Zolertia website][zolertia-site]
2. [CC2538 System-on-Chip Solution][cc2538]
3. [CC1200 sub-1GHz RF transceiver][cc1200]
4. [Zolertia Hackster channel][hackster]
5. [IoT in five days open source and online book][IoT5days]
2. [Zolertia Wiki page][zolertia-wiki]
3. [CC2538 System-on-Chip Solution][cc2538]
4. [CC1200 sub-1GHz RF transceiver][cc1200]
5. [Zolertia Hackster channel][hackster]
6. [IoT in five days open source and online book][IoT5days]
Maintainers
===========
@ -263,6 +264,7 @@ The Zoul and derived platforms (as well as the Z1 mote) are maintained by Zolert
Main contributor: Antonio Lignan <alignan@zolertia.com>
[zolertia-site]: http://www.zolertia.io/products "Zolertia"
[zolertia-wiki]: https://github.com/Zolertia/Resources/wiki "Zolertia Wiki"
[cc1200]: http://www.ti.com/product/cc1200 "CC1200"
[smart-rf-studio]: http://www.ti.com/tool/smartrftm-studio "SmartRF Studio"
[smart-rf-flashprog]: http://www.ti.com/tool/flash-programmer "SmartRF Flash Programmer"