Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "OM2M/one"
(→Going further - Advanced tutorials) |
|||
(10 intermediate revisions by 5 users not shown) | |||
Line 30: | Line 30: | ||
== Prerequisites == | == Prerequisites == | ||
− | * "JAVA 1. | + | * "JAVA 1.8" is required to run OM2M. |
* "Apache Maven 3" is required to build OM2M. | * "Apache Maven 3" is required to build OM2M. | ||
== Getting started == | == Getting started == | ||
− | * [[OM2M/one/Clone|Clone | + | * [[OM2M/one/Clone|Clone and Build the project]] |
− | * [[OM2M/one/Configuration|Config | + | * [[OM2M/one/Configuration|Config the node(s)]] |
− | * [[OM2M/one/Starting|Start | + | * [[OM2M/one/Starting|Start the node(s)]] |
* [[OM2M/one/Web_Interface|Web Interface]] | * [[OM2M/one/Web_Interface|Web Interface]] | ||
* [[OM2M/one/REST_API|REST API]] | * [[OM2M/one/REST_API|REST API]] | ||
+ | * [https://www.hackster.io/onem2m/onem2m-demo-57022e oneM2M demonstration using ESP8266 NodeMCU board and NodeJS application] | ||
+ | * [[OM2M/one/MQTT_Binding|How to use oneM2M MQTT binding]] | ||
== Going further - Advanced tutorials == | == Going further - Advanced tutorials == | ||
* [[OM2M/one/App | Develop oneM2M applications]] | * [[OM2M/one/App | Develop oneM2M applications]] | ||
* [[OM2M/one/Developer | Develop an Interworking Proxy Plugin]] | * [[OM2M/one/Developer | Develop an Interworking Proxy Plugin]] | ||
+ | * [[OM2M/one/DeveloperSDT | Develop an Interworking Proxy Application Entity (IPE) Plugin with SDT]] | ||
+ | * [[OM2M/one/PlayingWithSDT | Resources to play with SDT and TS-0023 specification (Home Automation Information Mapping)]] | ||
+ | * [[OM2M/one/FlexContainers | Developing with FlexContainers]] | ||
* [[OM2M/one/Advanced_DB|Change database config.]] | * [[OM2M/one/Advanced_DB|Change database config.]] | ||
− | * [[OM2M/one/IPE_Sample|IPE Sample architecture]] and good practices to create your own IPE. | + | * [[OM2M/one/DAL|Integrate OSGi DAL devices into OM2M by using DAL IPE Plugin]] |
+ | <!-- * [[OM2M/one/IPE_Sample|IPE Sample architecture]] and good practices to create your own IPE.--> | ||
== Project Roadmap == | == Project Roadmap == | ||
Line 51: | Line 57: | ||
Talks: | Talks: | ||
* [https://www.youtube.com/watch?v=pPTAdJZpnsk OM2M talk at EclipseCon San Francisco 2014] | * [https://www.youtube.com/watch?v=pPTAdJZpnsk OM2M talk at EclipseCon San Francisco 2014] | ||
+ | * [https://wiki.eclipse.org/images/8/8a/Eclipse_IOT_Day_OM2M.pdf (PDF) OM2M presentation at Eclipse IoT Days Grenoble 2016] | ||
+ | * [https://www.youtube.com/watch?v=CTsqzQH8iwI&index=6&list=PLy7t4z5SYNaRUZ7jOOuzrobwkyYqY7k5p (Video) OM2M at Eclipse IoT Days Grenoble 2016] | ||
Papers: | Papers: | ||
Line 57: | Line 65: | ||
Specifications: | Specifications: | ||
* [http://www.onem2m.org/library/index.cfm OneM2M standard specifications] | * [http://www.onem2m.org/library/index.cfm OneM2M standard specifications] | ||
− | |||
== Public Documentation == | == Public Documentation == |
Latest revision as of 05:58, 16 June 2018
OM2M | |
Website | |
Download | |
Community | |
Mailing List • Forums • IRC • mattermost | |
Issues | |
Open • Help Wanted • Bug Day | |
Contribute | |
Browse Source |
NEW: This page covers the oneM2M version of OM2M. If you are looking for documentation for the smartM2M version (v0.8.x) click here.
OM2M provides an open source service platform for M2M interoperability based on the oneM2M standard. OM2M follows a RESTful approach with open interfaces to enable developing services and applications independently of the underlying network. It proposes a modular architecture running on top of an OSGi layer, making it highly extensible via plugins. It supports multiple protocol bindings such as HTTP and CoAP. Various interworking proxies are provided to enable seamless communication with vendor-specific technologies such as Zigbee and Phidgets devices.
Contents
Introduction
OM2M provides a RESTful API for creating and managing M2M resources. It includes several primitive procedures to enable machines authentication, resources discovery, applications registration, containers management, synchronous and asynchronous communications, access rights authorization, groups organisation, re-targeting, etc.
This API operates on the following primary resource types:
- CseBase: describes the hosting CSE, and is the root for all other resources within the hosting CSE.
- remoteCse: stores information related to M2M CSEs residing on other M2M machines after successful mutual authentication. It enables Cses interactions using retargeting operations
- AE: stores information about the Application Entity after a successful registration on the hosting CSE.
- Container: acts as a mediator for data buffering to enable data exchange between applications and CSEs
- AccessControlPolicies: manages permissions and permissions holders to limit and protect the access to the resource tree structure.
- Group: enhances resources tree operations and simplifying the interactions on the API interfaces by adding the grouping feature. It enables an issuer to send one request to a set of receivers instead of sending requests one by one.
- Subscription: stores information related to subscriptions for some resources. It allow subscribers to receive asynchronous notification when an event happens such as the reception of new sensor event or the creation, update, or delete of a resource.
Prerequisites
- "JAVA 1.8" is required to run OM2M.
- "Apache Maven 3" is required to build OM2M.
Getting started
- Clone and Build the project
- Config the node(s)
- Start the node(s)
- Web Interface
- REST API
- oneM2M demonstration using ESP8266 NodeMCU board and NodeJS application
- How to use oneM2M MQTT binding
Going further - Advanced tutorials
- Develop oneM2M applications
- Develop an Interworking Proxy Plugin
- Develop an Interworking Proxy Application Entity (IPE) Plugin with SDT
- Resources to play with SDT and TS-0023 specification (Home Automation Information Mapping)
- Developing with FlexContainers
- Change database config.
- Integrate OSGi DAL devices into OM2M by using DAL IPE Plugin
Project Roadmap
- The OM2M roadmap is available here Roadmap
Interesting links
Talks:
- OM2M talk at EclipseCon San Francisco 2014
- (PDF) OM2M presentation at Eclipse IoT Days Grenoble 2016
- (Video) OM2M at Eclipse IoT Days Grenoble 2016
Papers:
Specifications:
Public Documentation
- Public documentation contains all Presentation slides, Videos, Scientific Publications, etc. related to the OM2M project.
OM2M Team
The OM2M project leads and contributors list is available here.