CoAP Chat Application for RIOT OS - Revision history

Awolfsbauer at 16:15, 26 March 2019

2019-03-26T16:15:46Z

← Older revision		Revision as of 16:15, 26 March 2019
Line 80:		Line 80:

	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 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 ==		== Used Hardware ==

Awolfsbauer at 16:10, 26 March 2019

2019-03-26T16:10:46Z

← Older revision		Revision as of 16:10, 26 March 2019
Line 40:		Line 40:
	=== Step 2 ===		=== Step 2 ===

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

	> help		> help
Line 79:		Line 79:
	Just type to send messages, when you are connected.		Just type to send messages, when you are connected.

	After setting a user with <code>/setuser</code>		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.

	== Used Hardware ==		== Used Hardware ==

Awolfsbauer at 16:03, 26 March 2019

2019-03-26T16:03:53Z

@@ Line 20: / Line 20: @@
 === Step 1 ===
-Enter these commands in the shell
+Clone the repository from https://git.fh-campuswien.ac.at/WP-ITS/riochat and compile it on the board you are using with:
-  echo foo
+  make BOARD= ''board name'' all
-  echo bar
-  test
+alternatively you can compile it in native mode, i.e without using an evaluation board:
-then these commands following
 === Step 2 ===
-Make sure to read
+After boot-up you can type help to see a list of all available commands:
-* War and Peace
+After setting a user with <code>/setuser</code>
 == Used Hardware ==

Awolfsbauer at 15:36, 26 March 2019

2019-03-26T15:36:42Z

← Older revision		Revision as of 15:36, 26 March 2019
Line 10:		Line 10:
	* Hardware: a compatible MCU, a list is available [https://github.com/RIOT-OS/RIOT/wiki/RIOT-Platforms here]		* 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 ~~toolchains~~ used by RIOT. Tutorials on how to do that can be found in the official RIOT ~~Github~~ repository and the official documentation:		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.		* The [https://github.com/RIOT-OS/RIOT/wiki RIOT GitHub wiki] contains all the information to get started.
Line 24:		Line 24:
	echo foo		echo foo
	echo bar		echo bar
			test
			then these commands following

			test
	=== Step 2 ===		=== Step 2 ===

Awolfsbauer at 15:19, 26 March 2019

2019-03-26T15:19:24Z

← Older revision		Revision as of 15:19, 26 March 2019
Line 35:		Line 35:
	== Used Hardware ==		== Used Hardware ==

	[[https://github.com/RIOT-OS/RIOT/wiki/Board:-SAMR21-xpro]]		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 ==

	~~== Courses ==~~		* https://github.com/RIOT-OS
			* https://doc.riot-os.org/index.html
	* ~~[[A course where this documentation was used]] (2017, 2018)~~		* https://www.microchip.com/wwwproducts/en/ATSAMR21G18A
	* ~~[[Another one]] (2018)~~

	~~== References ==~~

	* https://wikipedia.org
	* https://google.com

	[[Category:Documentation]]		[[Category:Documentation]]

Awolfsbauer at 15:07, 26 March 2019

2019-03-26T15:07:35Z

← Older revision		Revision as of 15:07, 26 March 2019
Line 2:		Line 2:

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

	== Requirements ==		== Requirements ==
Line 10:		Line 10:
	* Hardware: a compatible MCU, a list is available [https://github.com/RIOT-OS/RIOT/wiki/RIOT-Platforms here]		* 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 toolchains used by RIOT. Tutorials on how to do that can be found in the official RIOT Github repository:		In order to build and use this application, you need to install the toolchains 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.		* 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.		* 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 ==		== Description ==

Awolfsbauer at 15:03, 26 March 2019

2019-03-26T15:03:57Z

← Older revision		Revision as of 15:03, 26 March 2019
Line 10:		Line 10:
	* Hardware: a compatible MCU, a list is available [https://github.com/RIOT-OS/RIOT/wiki/RIOT-Platforms here]		* Hardware: a compatible MCU, a list is available [https://github.com/RIOT-OS/RIOT/wiki/RIOT-Platforms here]

	In order to ~~complete these steps~~, you ~~must have followed~~ [[~~Some Other Documentation]~~] ~~before~~.		In order to build and use this application, you need to install the toolchains used by RIOT. Tutorials on how to do that can be found in the official RIOT Github repository:

			* 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.

	== Description ==		== Description ==

Awolfsbauer at 14:52, 26 March 2019

2019-03-26T14:52:09Z

← Older revision		Revision as of 14:52, 26 March 2019
Line 1:		Line 1:
	== Summary ==		== Summary ==

	This documentation describes the setup and usage of a CoAP-based, chat application for the RIOT operating system.		This documentation describes the setup and usage of a
			[[Constrained Application Protocol \| CoAP]]-based, chat application for the RIOT operating system.

	== Requirements ==		== Requirements ==

	* Operating system: ~~RIOT OS~~ https://github.com/RIOT-OS/RIOT		* 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		* 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]		* Hardware: a compatible MCU, a list is available [https://github.com/RIOT-OS/RIOT/wiki/RIOT-Platforms here]

	In order to complete these steps, you must have followed [[Some Other Documentation]] before.		In order to complete these steps, you must have followed [[Some Other Documentation]] before.

Awolfsbauer: Created page with "== Summary == This documentation describes the setup and usage of a CoAP-based, chat application for the RIOT operating system. == Requirements == * Operating system: RIOT..."

2019-03-26T14:43:13Z

Created page with "== Summary == This documentation describes the setup and usage of a CoAP-based, chat application for the RIOT operating system. == Requirements == * Operating system: RIOT..."

New page

== Summary ==

This documentation describes the setup and usage of a CoAP-based, chat application for the RIOT operating system.

== Requirements ==

* Operating system: RIOT OS https://github.com/RIOT-OS/RIOT
* 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 complete these steps, you must have followed [[Some Other Documentation]] before.

== Description ==

=== Step 1 ===

Enter these commands in the shell

echo foo
echo bar

=== Step 2 ===

Make sure to read

* War and Peace
* Lord of the Rings
* The Baroque Cycle

== Used Hardware ==

[[https://github.com/RIOT-OS/RIOT/wiki/Board:-SAMR21-xpro]]

== Courses ==

* [[A course where this documentation was used]] (2017, 2018)
* [[Another one]] (2018)

== References ==

* https://wikipedia.org
* https://google.com

[[Category:Documentation]]