Skip to content

Commit

Permalink
Add REST API links, remove unnecessary categories, fix typos (#9)
Browse files Browse the repository at this point in the history
Fixes #8
  • Loading branch information
wborn authored Sep 16, 2024
1 parent 64ba94b commit 4aab7f5
Show file tree
Hide file tree
Showing 29 changed files with 113 additions and 126 deletions.
2 changes: 1 addition & 1 deletion docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The OpenRemote [Frontend](developer-guide/working-on-ui-and-apps.md) simplifies
We support the latest HTML standards and provide [web components](https://github.com/openremote/openremote/tree/master/ui/component) to build applications quickly, utilising the OpenRemote asset model and APIs: you can easily show all your assets on a map, for example. [Full web applications](https://github.com/openremote/openremote/tree/master/ui/app) are also bundled with OpenRemote, these can be used as templates for building custom web applications.


The OpenRemote [Android](https://github.com/openremote/console-android) and [iOS](https://github.com/openremote/console-ios) Consoles are native mobile applications that act as a shell for web applications built with the OpenRemote web components; a web browser is also considered to be a console and we automatically integrate native console features like push notifications and geo-fencing on each platform. If you have an existing website, add OpenRemote web components and wrap it in the OpenRemote console to connect your mobile users to your IoT network.
The OpenRemote [Android](https://github.com/openremote/console-android) and [iOS](https://github.com/openremote/console-ios) Consoles are native mobile applications that act as a shell for web applications built with the OpenRemote web components; a web browser is also considered to be a console and we automatically integrate native console features like push notifications and geofencing on each platform. If you have an existing website, add OpenRemote web components and wrap it in the OpenRemote console to connect your mobile users to your IoT network.

Security is paramount when it comes to IoT and out of the box the manager integrates with [Keycloak](https://www.keycloak.org/) to provide industry standard multi-tenant authentication; out of the box we also provide TLS/SSL when using our HAProxy-based reverse proxy.

Expand Down
2 changes: 1 addition & 1 deletion docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ For information and how to set up a development environment, see the [Developer

We work with Java, Groovy, TypeScript, Gradle, Docker, and a wide range of APIs and protocol implementations.

We follow the [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow) workflow with tags and releases for published versions of our components; when working on the codebase create descriptive branch names (e.g. `feature/cool_feature_x`, `hotfix/flux_capacitor`, `issue/123`, etc.).
We follow the [GitHub Flow](https://docs.github.com/en/get-started/quickstart/github-flow) workflow with tags and releases for published versions of our components; when working on the codebase create descriptive branch names (e.g. `feature/cool_feature_x`, `hotfix/flux_capacitor`, `issue/123`, etc.).

When your changes are complete then create a Pull Request ensuring that your branch is up-to-date with the source branch and that code changes are covered by tests and that the full test suite passes.

Expand Down
8 changes: 3 additions & 5 deletions docs/tutorials/configure-mobile-app-behaviour.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,9 @@ T.B.D.
Here we will explain how to configure your apps to be used in the OpenRemote mobile app. You have the option to show/not show on mobile, and for which realms the app is available. Also you can define whether realm options are shown as a list or input field (if you don't want to reveal all available realms).

Mobile apps can be found in the
[Apple Appstore](https://apps.apple.com/nl/app/openremote-app/id1526315885?mt=8) and [Google Playstore](https://play.google.com/store/apps/details?id=io.openremote.app&pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1)
[Apple App Store](https://apps.apple.com/nl/app/openremote-app/id1526315885?mt=8) and on [Google Play](https://play.google.com/store/apps/details?id=io.openremote.app&pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1).

The first time opening the app you will be asked three things: 'App Domain', 'Select an app' and 'Enter the Realm'. Switching between domains, apps and realms can be done by long-pressing the app icon on your home screen. If you are hosting an OpenRemote instance at https://yourhost.com use the following: 'App Domain' is 'yourhost.com'.<br />
<br />
The first time opening the app you will be asked three things: 'App Domain', 'Select an app' and 'Enter the Realm'. Switching between domains, apps and realms can be done by long-pressing the app icon on your home screen. If you are hosting an OpenRemote instance at https://yourhost.com use the following: 'App Domain' is 'yourhost.com'.

## Configure apps which can be selected

Expand All @@ -25,8 +24,7 @@ The `allowedApps` field allows you to customize the list of apps that is visible
For example: `{ allowedApps: ['manager', 'custom'] }`

Both of these options only impact the consoles, the URLs are still available on the web.<br />
If during use only one App is present, the consoles will automatically skip the 'app selection'-menu, and go straight to the app.<br />
<br />
If during use only one App is present, the consoles will automatically skip the 'app selection'-menu, and go straight to the app.

## Configure for which realms the app can be used

Expand Down
4 changes: 2 additions & 2 deletions docs/tutorials/connect-your-mqtt-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 2

# Connect your MQTT Client

In this tutorial we will use the [MQTT API](../user-guide/manager-apis/manager-apis.md#mqtt-api-mqtt-broker) to subscribe to changes of asset attributes values and publish data to them from a MQTT Client. The OpenRemote Manager functions as the MQTT Broker. You can use a desktop MQTT client (e.g. [MQTT Explorer](https://mqtt-explorer.com/) or [MQTT X](https://mqttx.app/)) for this tutorial, or better yet the device you want to connect.
In this tutorial we will use the [MQTT API](../user-guide/manager-apis.md#mqtt-api-mqtt-broker) to subscribe to changes of asset attributes values and publish data to them from a MQTT Client. The OpenRemote Manager functions as the MQTT Broker. You can use a desktop MQTT client (e.g. [MQTT Explorer](https://mqtt-explorer.com/) or [MQTT X](https://mqttx.app/)) for this tutorial, or better yet the device you want to connect.

## Create an asset with attributes
We will create a Thing asset, but feel free to use an AssetType that matches your physical device
Expand Down Expand Up @@ -36,7 +36,7 @@ In your MQTT client set up a new connection:
- clientID: `client123` (this can be anything you like but must be unique - Any existing connection with the same client ID will be replaced. Make sure this clientID remains identical.)

## Subscribe to attributes using the MQTT API
In this tutorial we will be looking at specific attributes of a specific asset. There are [many more options](../user-guide/manager-apis/manager-apis.md#mqtt-api-mqtt-broker) of subscribing to (all) updates of assets and attributes. The asset attributes that you will be subscribing to can be written by the user, by rules, or can be a live value gathered through an Agent link with another device in the field. You can imagine this boolean value could toggle a function of the device subscribed to the attribute
In this tutorial we will be looking at specific attributes of a specific asset. There are [many more options](../user-guide/manager-apis.md#mqtt-api-mqtt-broker) of subscribing to (all) updates of assets and attributes. The asset attributes that you will be subscribing to can be written by the user, by rules, or can be a live value gathered through an Agent link with another device in the field. You can imagine this boolean value could toggle a function of the device subscribed to the attribute
1. Get the ID of the Thing asset by navigating to its asset page and copying the ID in the URL (e.g. `http://localhost:9000/manager/#!assets/false/6xIa9MkpZuR7slaUGB6OTZ` => `6xIa9MkpZuR7slaUGB6OTZ`)
2. Create a subscription for the subscribeAttribute in your MQTT client with the topic: `{realm}/{clientId}/attribute/{attributeName}/{assetId}`. So in our case this will be `master/client123/attribute/subscribeAttribute/6xIa9MkpZuR7slaUGB6OTZ`
3. In the view mode of the Thing asset in the OpenRemote Manager, write a new value to the 'Subscribe attribute' by clicking the checkbox.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ This step-by-step guide requires the use of the OpenRemote Manager.
To import light assets, a ArtNet Agent must have been added to the asset tree.
From there, edit the ArtNet Agent's asset.
By collapsing the "ArtnetProtocolAgent" protocol configuration, you will be able to import Light assets in the "Protocol link import/discovery" attribute.
Before importing the JSON, an 'parent' asset must be targeted to where the lights will be appended to. We recommend to choose the same asset to were the ArtNet Agent resides.
Before importing the JSON, a 'parent' asset must be targeted to where the lights will be appended to. We recommend to choose the same asset to were the ArtNet Agent resides.
Finally the JSON can be imported by making use of the "Upload & import links from file" button.


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ DATABASE_CONNECTION_URL: jdbc:postgresql://localhost/openremote
## Connect an IKEA TRÅDFRI Gateway
In the following example, you link your existing IKEA TRÅDFRI Gateway by using its IP address, eg. `192.163.1.2`.
In the following example, you link your existing IKEA TRÅDFRI Gateway by using its IP address, e.g. `192.163.1.2`.

1. Login to the manager UI (`https://localhost/manager` as `admin/secret`)
2. Select the Assets tab and click `Create asset` at the top of the Asset list on the left
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Controller Protocol is intended to connect an OpenRemote Controller 2.5 to an Op
We'll explain how you can connect your own controller, or the existing Home Example Demo Controller.

## Connect an OpenRemote Controller
In the following example, you link your own controller by using the its controller address `http://my.controller:8688/controller`.
In the following example, you link your own controller by using the controller address `http://my.controller:8688/controller`.

1. Login to the manager UI (`https://localhost/manager` as `admin/secret`)
2. Select the Assets tab and click `Create asset` at the top of the Asset list on the left
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/agents-protocols/email.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ sidebar_position: 3

# E-mail

OpenRemote includes an e-mail client which can connect to your mail service. Through an e-mail agent you can receive e-mails and process the text into attribute values. Based on sending address and title data get's automatically linked to the correct asset in your instance.
OpenRemote includes an e-mail client which can connect to your mail service. Through an e-mail agent you can receive e-mails and process the text into attribute values. Based on sending address and title data gets automatically linked to the correct asset in your instance.

**See attributes in the Mail agent for further details on configuration**
2 changes: 1 addition & 1 deletion docs/user-guide/agents-protocols/lora.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 6

# LoRa

OpenRemote supports LoRa integration. You can connect OpenRemote to the most popular LoRa network servers (eg. ChirpStack and TTN), using their documented APIs. As example we have worked out this [Tutorial: connecting to LoRaWAN sensor data from Chirpstack](../../tutorials/receive-lorawan-sensor-data-from-chirpstack.md).
OpenRemote supports LoRa integration. You can connect OpenRemote to the most popular LoRa network servers (e.g. ChirpStack and TTN), using their documented APIs. As example we have worked out this [Tutorial: connecting to LoRaWAN sensor data from Chirpstack](../../tutorials/receive-lorawan-sensor-data-from-chirpstack.md).

## Proof of concept for LoRa mesh network for GPS trackers

Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/agents-protocols/mqtt.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ sidebar_position: 7
There is an MQTT Agent (Client) in OpenRemote that you can use to connect to an external MQTT Broker. First use the MQTT Agent to establish the connection to the broker. Then create an asset with attribute(s) of the Value Type that matches the incoming/outgoing data, and give those attributes the configuration item 'Agent Link'. In this agent link select your MQTT Agent and add the parameter Publish Topic or Subscription Topic.
We have no extensive documentation yet, and recommend to [check our forum](https://forum.openremote.io/t/mqtt-agents-publish-subscription/985).

OpenRemote also has an [MQTT Broker](../manager-apis/manager-apis.md#mqtt-api-mqtt-broker) (or MQTT API).
OpenRemote also has an [MQTT Broker](../manager-apis.md#mqtt-api-mqtt-broker) (or MQTT API).

## See also

- [Agent overview](overview.md)
- [MQTT Broker](../manager-apis/manager-apis.md#mqtt-api-mqtt-broker)
- [MQTT Broker](../manager-apis.md#mqtt-api-mqtt-broker)
- [Quick Start](https://github.com/openremote/openremote/blob/master/README.md)
- [Manager UI Guide](../manager-ui/manager-ui.md)
- [Custom Deployment](../deploying/custom-deployment.md)
Expand Down
Loading

0 comments on commit 4aab7f5

Please sign in to comment.