mirror of
https://github.com/OpenMTC/OpenMTC.git
synced 2024-12-30 17:57:03 +00:00
3fc8bdb14e
* Moved badges to top - two rows * Formatted Markdown file * Added lede at the top of file so a description paragraph will display on mobile * Standardized some Section names (e.g. Install) * Added standard QA section - TSC **must** requirement * Expanded License to include copyrights * Updated catalogue links to new GitHub location [standard-readme](https://github.com/RichardLitt/standard-readme) is a simple standard naming convention for README files which makes reading and navigation of the documentation easier - this is a TSC **should** requirement Created Readthedocs index file.
97 lines
4.5 KiB
Markdown
97 lines
4.5 KiB
Markdown
<p align="left">
|
|
<a href="http://www.openmtc.org/">
|
|
<img src="http://www.openmtc.org/assets/img/OpenMTC_Logo_Orange.svg" width="400"/>
|
|
</a>
|
|
</p>
|
|
|
|
[](https://www.fiware.org/developers/catalogue/)
|
|
[](https://www.eclipse.org/legal/epl-v10.html)
|
|
[](https://stackoverflow.com/questions/tagged/fiware+iot)
|
|
<br/>
|
|
[](http://fiware-openmtc.readthedocs.org/en/latest/?badge=latest)
|
|
|
|
|
|
The OpenMTC SDK aims to provide developers with a convenient yet flexible tool
|
|
to write oneM2M compliant applications. This includes network applications
|
|
(NAs), gateway application (GAs), device applications (DAs), as well as
|
|
interworking proxy entities (IPEs).
|
|
|
|
This project is part of [FIWARE](https://www.fiware.org/). For more information
|
|
check the FIWARE Catalogue entry for the
|
|
[IoT Agents](https://github.com/Fiware/catalogue/tree/master/iot-agents).
|
|
|
|
# Content
|
|
|
|
- [Install](#install)
|
|
- [Usage](#usage)
|
|
- [API](#api)
|
|
- [Quality Assurance](#quality-assurance)
|
|
- [License](#license)
|
|
|
|
|
|
## Install
|
|
|
|
Information about how to install the JSON IoTAgent can be found at the
|
|
corresponding section of the
|
|
[Installation & Administration Guide](https://fiware-openmtc.readthedocs.io/en/latest/deployment-guide).
|
|
|
|
## Usage
|
|
|
|
Information about how to use the IoT Agent can be found in the
|
|
[User & Programmers Manual](https://fiware-openmtc.readthedocs.io/en/latest/introduction).
|
|
|
|
## API
|
|
|
|
Information about the REST API can be found in the
|
|
[API Section](https://fiware-openmtc.readthedocs.io/en/latest/overview-rest-api)
|
|
|
|
|
|
## Python
|
|
|
|
The OpenMTC SDK is written in and for the Python programming language. Users
|
|
should therefore have at least a certain knowledge of Python and its paradigms.
|
|
For this matter, the following material is recommended:
|
|
|
|
- [The Python Homepage](http://www.python.org)
|
|
- [Expert Python Programming by Tarek Ziadé](http://www.e-reading.by/bookreader.php/138816/Ziade_-_Expert_Python_programming.pdf)
|
|
- [Code Like a Pythonista: Idiomatic Python](http://www.omahapython.org/IdiomaticPython.html)
|
|
|
|
## Feedback
|
|
|
|
Please create issues for any problems and direct any comments or feedback you
|
|
are having to <a href="mailto:support@openmtc.org">support@openmtc.org</a>
|
|
|
|
Please let us know what you think. We are also very interested in any use case
|
|
you are _not_ able to implement with the SDK or if you find it difficult to do
|
|
so.
|
|
|
|
|
|
## Quality Assurance
|
|
|
|
This project is part of [FIWARE](https://fiware.org/) and has been rated as
|
|
follows:
|
|
|
|
- **Version Tested:**
|
|
|
|
- **Documentation:**
|
|
|
|
|
|
- **Responsiveness:**
|
|
|
|
|
|
- **FIWARE Testing:**
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
## Licence
|
|
|
|
The OpenMTC SDK is licensed under the Eclipse Public License (EPL)
|
|
version 1.
|
|
|
|
© 2018 OpenMTC
|
|
|