Skip to content

Commit

Permalink
Add basic worked examples for using the gateway
Browse files Browse the repository at this point in the history
Signed-off-by: Tim Ward <timothyjward@apache.org>
  • Loading branch information
timothyjward committed Aug 23, 2023
1 parent 4b66817 commit d75fd80
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/Main.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,12 @@ This is the documentation for the Eclipse sensiNact gateway
* [Launching](distribution/Distribution.md) - Learn about how Eclipse sensiNact gateway's modular architecture
* [Northbound](northbound/Northbound.md) - Learn about options for interacting with the gateway
* [Southbound](southbound/Southbound.md) - Learn about options for connecting devices to the gateway

## Getting Started

The following examples will help you to quickly get started with the sensiNact gateway

* [Downloading and Launching](examples/Download.md) - See how to download and start sensiNact
* [Configuring and Querying](examples/Configuring.md) - See how to change sensiNact's configuration and access the REST interface
* [Interacting with a southbound device](examples/Interacting.md) - See how to read a device's data, change editable fields, and listen for updates.
* Building your own Southbound Provider - TODO
Empty file added docs/examples/Configuring.md
Empty file.
33 changes: 33 additions & 0 deletions docs/examples/Download.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Downloading and Launching sensiNact

This worked example aims to get you started with running sensiNact for the first time.

## Downloading sensiNact

Eclipse sensiNact is published to the Eclipse Nexus repository instance at [https://repo.eclipse.org](https://repo.eclipse.org). You can find it directly there, or use the maven-dependency plugin to find it for you.

mvn dependency:get -DremoteRepositories=https://repo.eclipse.org/content/groups/sensinact/ \
-Dartifact=org.eclipse.sensinact.gateway.distribution:assembly:0.0.2-SNAPSHOT:zip -Ddest=sensinact.zip

## Installing sensiNact

Once you have obtained the sensiNact assembly you can unzip it using your favourite zip tool

unzip sensinact.zip

The unzipped contents will include several folders and files including:

* `configuration` - the folder containing the configuration for the gateway instance
* `features` - the folder containing the available features that can be installed into this gateway
* `launch` - the folder containing the sensiNact launcher responsible for bootstrapping the gateway
* `repository` - a maven layout repository containing the bundles used by the gateway features
* `start.sh` - a launch script for sensiNact

## Starting sensiNact

Starting sensiNact can be achieved simply by executing the start script

./start.sh

> [!WARNING]
> If you are unable to execute the start script try setting the executable permission bit using `chmod +x start.sh`
Empty file added docs/examples/Interacting.md
Empty file.

0 comments on commit d75fd80

Please sign in to comment.