README.md 2.06 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
jCoAP is a java implementation of the Contrained Application Protocol (RFC 7252).
It supports:
* RFC 7641 CoAP Observe
* RFC 7390 CoAP Group Communication
* CoAP Blockwise Transfer
* RFC 6690 CoRE Link Format (.well-known/core)

# Build using Maven

You need to have a working maven installation to build jCoAP.
Then simply run the following from the project's root directory:

```sh
$ mvn clean install
```

Executable JARs of the examples with all dependencies can be found in the `target\` folder.

Björn Butzin's avatar
Björn Butzin committed
19
# Usage in Maven Projects
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

To use jCoAP as a library in your projects, add the following dependency
to your `pom.xml` (without the dots):

```xml
<dependencies>
	...
	<dependency>
		<groupId>org.ws4d.jcoap</groupId>
		<artifactId>core</artifactId>
		<version>1.1.1-SNAPSHOT</version>
  	</dependency>
	...
</dependencies>
...
```

# Eclipse

The project can be easily imported into a recent version of the Eclipse IDE.
Björn Butzin's avatar
Björn Butzin committed
40
Make sure to have the following before importing:
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

* [Eclipse EGit](http://www.eclipse.org/egit/) (should be the case with every recent Eclipse version)
* [m2e - Maven Integration for Eclipse](http://www.eclipse.org/m2e/) (should be the case with every recent Eclipse version)
* UTF-8 workspace text file encoding (Preferences &raquo; General &raquo; Workspace)

Then choose *[Import... &raquo; Maven &raquo; Existing Maven Projects]* to import `jCoAP projects` into Eclipse.

To run the build process from Eclipse select a project then right click *[Run As &raquo; Maven install]*

# IntelliJ

The project can also be imported to IntelliJ as follows:

In IntelliJ, choose *[File.. &raquo; Open]* then select the location of the cloned repository in your filesystem.
IntelliJ will then automatically import all projects and resolve required Maven dependencies.

# License
jCoAP is licensed under Apache License, Version 2.0 see `license.txt`

# Third Party Software
61
62
63
jCoAP uses the folowing third party components
* log4j ([Apache License, Version2.0][http://www.apache.org/licenses/LICENSE-2.0.html])
* jUnit ([Eclipse Public License - v 1.0][https://www.eclipse.org/legal/epl-v10.html])