View source for CoAP Chat Application for RIOT OS

== Summary == 

This documentation describes the setup and usage of a 
[[Constrained Application Protocol | CoAP]]-based, chat application for the [https://riot-os.org/ RIOT] operating system.

== Requirements ==

* Operating system: [https://github.com/RIOT-OS/RIOT RIOT OS]
* Packages: https://git.fh-campuswien.ac.at/WP-ITS/riochat (Note: this package already includes RIOT OS)
* Hardware: a compatible MCU, a list is available [https://github.com/RIOT-OS/RIOT/wiki/RIOT-Platforms here]
 
In order to build and use this application, you need to install the tool chains used by RIOT. Tutorials on how to do that can be found in the official RIOT GitHub repository and the official documentation:

* The [https://github.com/RIOT-OS/RIOT/wiki RIOT GitHub wiki] contains all the information to get started.
* A detailed step-by-step [https://github.com/RIOT-OS/Tutorials/blob/master/README.md Tutorial] is also available.
* The official [https://doc.riot-os.org/index.html RIOT Documentation].

== Description ==

=== Step 1 ===

Clone the repository from https://git.fh-campuswien.ac.at/WP-ITS/riochat and compile it on the board you are using with: 

 make BOARD= ''board name'' all

alternatively you can compile it in native mode, i.e without using an evaluation board:

 make BOARD=native all

If you are using native mode, you will need to setup a [https://github.com/RIOT-OS/RIOT/wiki/Virtual-riot-network#your-first-topology-2-nodes-1-hop Virtual RIOT network] with at least two TAP devices, for communication between nodes. This can be achieved with the following script:
 
 RIOT/dist/tools/tapsetup/tapsetup -c 2

Open a two terminals and run two nodes. The first with tap0 and the other with tap1.

 make BOARD=native PORT=tap0 term

 make BOARD=native PORT=tap1 term

=== Step 2 ===

After boot-up you can type <code>help</code> to see a list of all available commands:

 > help
 help
 Command              Description
 ---------------------------------------
 server               Riot CoAP Server
 client               Riot CoAP Client
 s                    Riot CoAP Server
 c                    Riot CoAP Client
 reboot               Reboot the node
 ps                   Prints information about running threads.
 ping6                Ping via ICMPv6
 random_init          initializes the PRNG
 random_get           returns 32 bit of pseudo randomness
 nib                  Configure neighbor information base
 ifconfig             Configure network interfaces

Run client on one board (or terminal for native) and server on another.

=== Step 3 ===

After starting a client on a node you are greeted with the following options:

 Help Screen:
 Command            Parameters         Description
 ----------------------------------------------------------------------
 /discovery[/d]                        send broadcast to find server
 /connect[/c]                          connect to set server
 /list[/l]                             list discovered server
 /info[/i]                             get server info
 /setserver[/ss]    [serverid]         set server to serverid
 /setuser[/su]      [username]         set user to username
 /options[/o]                          show config
 /help[/h]                             this screen
 /exit[/e]                             exit RioChat, drop back to Shell
 ----------------------------------------------------------------------
 Just type to send messages, when you are connected.

After setting a user with <code>/setuser</code> you need to run <code>/discovery</code> to send a broadcast to find the server. <code>/list</code> shows you a list of discovered servers. Each server has a name a server address (IPv6) and an id. With <code>/setserver</code> you can set the server id to your desired server and with <code>/connect</code>, connect to it.
After you are connected you can type messages and send them to all clients that are connected to the server.

== Used Hardware ==

This project was realized with the [https://github.com/RIOT-OS/RIOT/wiki/Board:-SAMR21-xpro SAMR21-xpro] evaluation board by Atmel. It features the [https://www.microchip.com/wwwproducts/en/ATSAMR21G18A ATSAMR21G18A] SoC by Microchip. It contains an ARM® Cortex®-M0+ based 32-bit MCU with a 2.4GHz RF transceiver compliant with IEEE 802.15.4 standard.

== References ==

* https://github.com/RIOT-OS
* https://doc.riot-os.org/index.html
* https://www.microchip.com/wwwproducts/en/ATSAMR21G18A


[[Category:Documentation]]