Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "SensiNact"

 
(23 intermediate revisions by 3 users not shown)
Line 7: Line 7:
 
| product = sensinact
 
| product = sensinact
 
}}  
 
}}  
 +
 +
[[Category:sensiNact]]
 +
 +
== WARNING ==
 +
 +
This documentation wiki is out of date, please look at https://eclipse-sensinact.readthedocs.io/ for the latest version.
 +
 +
----
  
 
'''Eclipse sensiNact''' (lower-case on the first '''s''' and capital letter on the second '''N''') aims at creating a common environment in which heterogeneous devices can exchange information and interact among each other in the IoT world.
 
'''Eclipse sensiNact''' (lower-case on the first '''s''' and capital letter on the second '''N''') aims at creating a common environment in which heterogeneous devices can exchange information and interact among each other in the IoT world.
  
[[Image:sensiNact_logo.png|frame|none|alt=sensiNact Logo|caption sensiNact Logo]]
+
[[File:sensiNact_logo.png|150px|sensiNact Logo]]
  
 
'''Eclipse sensiNact''' is composed of two tools, '''sensiNact Gateway''' aiming at integrating devices and aggregating data from various sources and '''sensiNact Studio''' aiming at interacting with the sensiNact Gateway to visualize the devices and the data.
 
'''Eclipse sensiNact''' is composed of two tools, '''sensiNact Gateway''' aiming at integrating devices and aggregating data from various sources and '''sensiNact Studio''' aiming at interacting with the sensiNact Gateway to visualize the devices and the data.
  
[[Image:sna_architecture.png|frame|none|alt=Overview of the sensiNact ecosystem|caption Overview of the sensiNact ecosystem]]
+
[[File:sna_architecture.png|300px|Overview of the sensiNact ecosystem]]
  
This documentation will help you to install, develop and use sensiNact in your environment with your use cases.
+
sensiNact is a horizontal platform dedicated to IoT and in particularly used in various smart city and smart home applications. sensiNact aims at managing IoT protocols and devices heterogeneity and provides synchronous (on demand) and asynchronous (periodic or event based) access to data/actions of IoT devices, as well as access to historic data with generic and easy-to-use API. To achieve these objectives, sensiNact comes with two complementary frameworks:
  
=== Start guides ===
+
* sensiNact Gateway interconnects IoT devices using different southbound IoT protocols such as Zigbee, EnOcean, LoRa, XBee, MQTT, XMPP, as well as platforms such as FIWARE and allows access to them with various northbound protocols such as HTTP REST, MQTT, XMPP, JSON RPC and CDMI. The gateway can also host applications and manage them using an application manager module.
 +
* sensiNact Studio proposes an IDE (Integrated Development Environment) based on Eclipse to manage the existing devices, in addition to develop, deploy and manage IoT applications.
  
This section proposes two guides. A quick guide for the users wanting to setup the installation of sensiNact quickly and full guides where a detailed description is proposed to understand some of the concepts behind sensiNact.
+
== Installation ==
  
= sensiNact Gateway =
+
* [[SensiNact/gateway-installation|Gateway installation]]
 +
* [[SensiNact/studio-installation|Studio installation]]
  
This section details the Gateway, its concepts and its modules.
+
== Starting with sensiNact ==
  
== Documentation ==
+
* [[SensiNact/Data Model|sensiNact Data Model]]
 +
* [[SensiNact/studio-basic-usage|Studio basic usage]]
  
* [[sensinact-full-start|Installation]]
+
== Configuration ==
* [[SensiNact/Gateway Overview|Gateway overview]]
+
* [[SensiNact/Gateway Core|Core]]
+
* [[SensiNact/Gateway Security|Security]]
+
* [[SensiNact/AppManager|AppManager]]
+
* [[endpoint-connector|Endpoint connector]]
+
* [[gateway-felix-configuration|HTTPS Felix Configuration]]
+
* [[SensiNact/Bridges|Bridges]]
+
  
= Tutorials =
+
* [[SensiNact/endpoint-connector|Endpoint connector]]
 +
* [[SensiNact/gateway-felix-configuration|HTTPS Felix Configuration]]
 +
* [[SensiNact/gateway-remote|SensiNact Remote]]
 +
 
 +
== sensiNact gateway internals ==
 +
 
 +
* [[SensiNact/Gateway Architecture|Gateway Architecture]]
 +
* [[SensiNact/Gateway Core|Gateway Core]]
 +
* [[SensiNact/Gateway Security|Gateway Security]]
 +
* [[SensiNact/AppManager|AppManager]]
  
This section proposes various tutorials to help users and developers to learn more about sensiNact.
+
== Working with bridges ==
  
 +
* [[SensiNact/Bridges|Bridges introduction]]
 
* [[SensiNact/Tutorial Bridge|How to develop a southbound bridge]] (requires knowledge about Java, such as the architecture and the data model of sensiNact)
 
* [[SensiNact/Tutorial Bridge|How to develop a southbound bridge]] (requires knowledge about Java, such as the architecture and the data model of sensiNact)
* [[gateway-bridge-local-config|How to create sensinact bridge local configuration]]
+
* [[SensiNact/gateway-bridge-local-config|How to create sensinact bridge local configuration]]
  
= Development =
+
== Development ==
  
The sensiNact project uses the continuous integration infrastructure from Eclipse.
+
'''Repositories'''
  
The [https://ci.eclipse.org/sensinact/ Eclipse Jenkins] runs a compilation of the sensiNact Gateway every day (or night, depending on your timezone). The resulting compilation generates a stand alone snapshot distribution that is available at the following address: [https://www.eclipse.org/downloads/download.php?file=/sensinact/gateway/snapshot/sensiNact-gateway-1.5-SNAPSHOT-latest.zip latest build]. Ten builds are kept in the download area of Eclipse.
+
* [https://git.eclipse.org/c/sensinact/org.eclipse.sensinact.gateway.git Gateway repository]
 +
* [https://git.eclipse.org/c/sensinact/org.eclipse.sensinact.studio.git Studio repository]
 +
* [https://git.eclipse.org/c/sensinact/org.eclipse.sensinact.studioweb.git Studio web repository]
  
Each module of the sensiNact gateway is available in the [https://repo.eclipse.org/#view-repositories;sensinact~browsestorage Eclipse Nexus].
 
  
The same compilation process is under development for the sensiNact Studio.
+
'''CI'''
  
A sonar report should be available soon at the following address: [https://sonar.eclipse.org/dashboard/index/173758 Eclipse Sonar]
+
* [https://ci.eclipse.org/sensinact/ Jenkins dashboard]
 +
** [https://www.eclipse.org/downloads/download.php?file=/sensinact/gateway/snapshot/sensiNact-gateway-1.5-SNAPSHOT-latest.zip latest 1.5 build]
 +
** [https://www.eclipse.org/downloads/download.php?file=/sensinact/gateway/snapshot/sensiNact-gateway-2.0-SNAPSHOT-latest.zip latest 2.0 build]
 +
* [https://repo.eclipse.org/#view-repositories;sensinact~browsestorage Nexus interface].
 +
* [https://sonar.eclipse.org/dashboard/index/173758 Sonar dashboard]

Latest revision as of 11:08, 23 February 2024

Eclipse sensiNact
Website
Download
Community
Mailing ListForumsIRCmattermost
Issues
OpenHelp WantedBug Day
Contribute
Browse Source

WARNING

This documentation wiki is out of date, please look at https://eclipse-sensinact.readthedocs.io/ for the latest version.


Eclipse sensiNact (lower-case on the first s and capital letter on the second N) aims at creating a common environment in which heterogeneous devices can exchange information and interact among each other in the IoT world.

sensiNact Logo

Eclipse sensiNact is composed of two tools, sensiNact Gateway aiming at integrating devices and aggregating data from various sources and sensiNact Studio aiming at interacting with the sensiNact Gateway to visualize the devices and the data.

Overview of the sensiNact ecosystem

sensiNact is a horizontal platform dedicated to IoT and in particularly used in various smart city and smart home applications. sensiNact aims at managing IoT protocols and devices heterogeneity and provides synchronous (on demand) and asynchronous (periodic or event based) access to data/actions of IoT devices, as well as access to historic data with generic and easy-to-use API. To achieve these objectives, sensiNact comes with two complementary frameworks:

  • sensiNact Gateway interconnects IoT devices using different southbound IoT protocols such as Zigbee, EnOcean, LoRa, XBee, MQTT, XMPP, as well as platforms such as FIWARE and allows access to them with various northbound protocols such as HTTP REST, MQTT, XMPP, JSON RPC and CDMI. The gateway can also host applications and manage them using an application manager module.
  • sensiNact Studio proposes an IDE (Integrated Development Environment) based on Eclipse to manage the existing devices, in addition to develop, deploy and manage IoT applications.

Installation

Starting with sensiNact

Configuration

sensiNact gateway internals

Working with bridges

Development

Repositories


CI

Back to the top