Add documentation images

openremote · Jun 3, 2024 · a0748af · a0748af
1 parent 64ef0a4
commit a0748af
Show file tree

Hide file tree

Showing 82 changed files with 66 additions and 66 deletions.
diff --git a/docs/developer-guide/adding-widgets-on-insights.md b/docs/developer-guide/adding-widgets-on-insights.md
@@ -12,13 +12,13 @@ Currently we have several built-in widgets available:<br />
 
 | Widget | Description
 |---|---|
-|![image](https://github.com/openremote/openremote/assets/27913110/b0ee048a-998b-4fd7-b557-c41366fa965a)| An attribute field with the ability to edit its value within the dashboard itself.<br /> It works similar to the asset page, where the control changes depending on the attribute type. |
-|![image](https://github.com/openremote/openremote/assets/27913110/143f1148-40bb-4612-9719-c820dff22e46)| Measuring instrument to compare the current value of an attribute with some predefined thresholds. |
-|![image](https://github.com/openremote/openremote/assets/27913110/16a1a783-ada3-402f-b304-cfdbee6f4994)| Background image with attribute value labels that can be placed anywhere. |
-|![image](https://github.com/openremote/openremote/assets/27913110/d19d9352-d31a-4cdf-9598-8a14f260ca42)| Displays the current value of an attribute, and shows the trend in a chart. |
-|![image](https://github.com/openremote/openremote/assets/27913110/a8036ec9-7c24-4a20-ad53-94ba801aa26c)| Chart with history and/or predicted data of unlimited attributes.<br />Uses data decimation algorithms, and supports multi-axis. |
-|![image](https://github.com/openremote/openremote/assets/27913110/c4c2ac19-d0ba-497a-af32-073b23d9d79c)| Map with locations of all assets that correspond with the selected asset type.<br />Optionally it can show a color based on thresholds, or a label with the current value of an attribute. |
-|![image](https://github.com/openremote/openremote/assets/27913110/81978397-f8cc-4774-b8ff-60536560e8e5)| Table showing multiple attribute values of the assets you select.<br /> It is very useful for gaining insights in a larger number of assets with a single look. |
+|![image](img/attribute-widget.png)| An attribute field with the ability to edit its value within the dashboard itself.<br /> It works similar to the asset page, where the control changes depending on the attribute type. |
+|![image](img/gauge-widget.png)| Measuring instrument to compare the current value of an attribute with some predefined thresholds. |
+|![image](img/image-widget.png)| Background image with attribute value labels that can be placed anywhere. |
+|![image](img/kpi-widget.png)| Displays the current value of an attribute, and shows the trend in a chart. |
+|![image](img/line-chart-widget.png)| Chart with history and/or predicted data of unlimited attributes.<br />Uses data decimation algorithms, and supports multi-axis. |
+|![image](img/map-widget.png)| Map with locations of all assets that correspond with the selected asset type.<br />Optionally it can show a color based on thresholds, or a label with the current value of an attribute. |
+|![image](img/table-widget.png)| Table showing multiple attribute values of the assets you select.<br /> It is very useful for gaining insights in a larger number of assets with a single look. |
 
 
 We might add more widgets over time, so this list can become longer.<br />

diff --git a/docs/developer-guide/img/attribute-widget.png b/docs/developer-guide/img/attribute-widget.png
diff --git a/docs/developer-guide/img/gauge-widget.png b/docs/developer-guide/img/gauge-widget.png
diff --git a/docs/developer-guide/img/image-widget.png b/docs/developer-guide/img/image-widget.png
diff --git a/docs/developer-guide/img/kpi-widget.png b/docs/developer-guide/img/kpi-widget.png
diff --git a/docs/developer-guide/img/line-chart-widget.png b/docs/developer-guide/img/line-chart-widget.png
diff --git a/docs/developer-guide/img/map-widget.png b/docs/developer-guide/img/map-widget.png
diff --git a/docs/developer-guide/img/table-widget.png b/docs/developer-guide/img/table-widget.png
diff --git a/docs/img/architecture.jpg b/docs/img/architecture.jpg
diff --git a/docs/introduction.md b/docs/introduction.md
@@ -8,7 +8,7 @@ sidebar_position: 1
 
 **OpenRemote is the only 100% open source IoT platform that simplifies connecting networked assets to mobile and web applications.**
 
-<img src="https://openremote.io/wp-content/uploads/2023/09/OpenRemote_Architecture-scaled.jpg" width="900"/>
+![image](img/architecture.jpg)
 
 The core of the OpenRemote system is the [Manager](https://github.com/openremote/openremote/tree/master/manager), a headless Java application that forms an IoT context broker which captures the current asset state of the system. You can create a dynamic schema of your assets and their attributes in the manager, modelling the problem domain. For example, you would create Building, Apartment, Room, and Sensor assets to model an IoT system for a smart home or office.
 

diff --git a/docs/quick-start.md b/docs/quick-start.md
@@ -8,7 +8,7 @@ Welcome to OpenRemote; an intuitive user-friendly 100% open source IoT platform.
 
 As the code base is 100% open source, applications are limitless. Here's an architecture overview:
 
-<img src="https://openremote.io/wp-content/uploads/2023/09/OpenRemote_Architecture-scaled.jpg" width="900"/>
+![image](img/architecture.jpg)
 
 You can quickly try the online demo with restricted access, login credentials are `smartcity:smartcity`:
 

diff --git a/docs/tutorials/change-celsius-to-fahrenheit-with-flow.md b/docs/tutorials/change-celsius-to-fahrenheit-with-flow.md
@@ -13,12 +13,12 @@ First of all create the attribute you want to show the temperature in Fahrenheit
 * selected “Store data points” (so you can look back at historical values)
 * added the unit Fahrenheit
 
-<kbd>![Add Fahrenheit attribute](https://github.com/openremote/Documentation/blob/master/manuscript/figures/Flow%20-%20New%20attribute%20for%20flow.png)</kbd>
+<kbd>![Add Fahrenheit attribute](img/flow-new-attribute-for-flow.png)</kbd>
 
 Next create a flow in the flow editor, which looks like this:
 
-<kbd>![Flow from Celsius to Fahrenheit](https://github.com/openremote/Documentation/blob/master/manuscript/figures/Flow%20-%20Celcius%20to%20Fahrenheit.png)</kbd>
+<kbd>![Flow from Celsius to Fahrenheit](img/flow-celsius-to-fahrenheit.png)</kbd>
 
-You will now have the second temperature in Fahrenheit filled once the temperature in Celcius updates. It will look like this.
+You will now have the second temperature in Fahrenheit filled once the temperature in Celsius updates. It will look like this.
 
-<kbd>![Fahrenheit attribute as filled by the flow](https://github.com/openremote/Documentation/blob/master/manuscript/figures/Flow%20-%20the%20Fahrenheit%20result.png)</kbd>
+<kbd>![Fahrenheit attribute as filled by the flow](img/flow-the-fahrenheit-result.png)</kbd>
diff --git a/docs/tutorials/img/flow-celsius-to-fahrenheit.png b/docs/tutorials/img/flow-celsius-to-fahrenheit.png
diff --git a/docs/tutorials/img/flow-new-attribute-for-flow.png b/docs/tutorials/img/flow-new-attribute-for-flow.png
diff --git a/docs/tutorials/img/flow-the-fahrenheit-result.png b/docs/tutorials/img/flow-the-fahrenheit-result.png
diff --git a/docs/tutorials/img/replay-data.png b/docs/tutorials/img/replay-data.png
diff --git a/docs/tutorials/img/simulator-agent-link.png b/docs/tutorials/img/simulator-agent-link.png
diff --git a/docs/tutorials/simulating-data-in-attribute.md b/docs/tutorials/simulating-data-in-attribute.md
@@ -9,10 +9,10 @@ If you don't have a data connection running yet or want to simulate the behaviou
 2. Add the configuration 'Agent link' to the attribute you want to replay data for.
 3. Select the 'SimulatorAgentLink'.
 
-![Screenshot 2022-05-16 at 09 39 36](https://user-images.githubusercontent.com/11444149/168543105-99d11283-b427-404f-a9d8-3a6449ab87d1.png)
+![SimulatorAgentLink](img/simulator-agent-link.png)
 
 4. Open the 'Replay data' JSON for this attribute and add a number and the related timestamps (seconds) for a 24hr time period.
 
-![Screenshot 2022-05-16 at 09 41 08](https://user-images.githubusercontent.com/11444149/168543257-d1ff69a7-551b-4cbb-9763-7c31e42c7284.png)
+![Replay data](img/replay-data.png)
 
 5. You will now see the attribute replaying the filled in data.
diff --git a/docs/user-guide/agents-protocols/img/teltonika-networks.png b/docs/user-guide/agents-protocols/img/teltonika-networks.png
diff --git a/docs/user-guide/agents-protocols/img/teltonika-telematics.png b/docs/user-guide/agents-protocols/img/teltonika-telematics.png
diff --git a/docs/user-guide/agents-protocols/partner-integrations.md b/docs/user-guide/agents-protocols/partner-integrations.md
@@ -9,7 +9,7 @@ Below is a short list of companies who actively offer and maintain integrations
 As we are 100% open source we invite other companies to develop an integration. To be listed we only expect maintenance of these integrations. You can always [contact us](https://openremote.io/contact/) to get going.
 
 ## Teltonika Networks 
-![TELTONIKA-NETWORKS](https://github.com/openremote/openremote/assets/11444149/9db89a89-6b50-4be6-b2b6-fb991c61062c)
+![TELTONIKA-NETWORKS](img/teltonika-networks.png)
 
 [Teltonika Networks](https://teltonika-networks.com/?utm_source=iotplatform&utm_medium=referral&utm_content=openremote) offers a range of network products such as gateways, routers, modems and switches. With in-house R&D as well manufacturing facilities, it offers industrial grade solutions. Their solutions connect easily with OpenRemote, e.g. using the MQTT broker.
 
@@ -18,7 +18,7 @@ Documentation:
 - [OpenRemote Wiki - Manager APIs - MQTT Broker](../manager-apis/manager-apis.md#mqtt-api-mqtt-broker)
 
 ## Teltonika Vehicle Telematics
-![TELTONIKA-Telematics](https://github.com/openremote/openremote/assets/11444149/67c90fe1-2a69-4119-a2ce-5fb9d5476cb5)
+![TELTONIKA-Telematics](img/teltonika-telematics.png)
 
 [Teltonika Telematics](https://teltonika-gps.com/?utm_source=iotplatform&utm_medium=referral&utm_content=openremote) offers a range of vehicle telematics devices, like GPS trackers for road and sea vehicles, and more. With in-house R&D as well manufacturing facilities, it offers industrial grade solutions for any sort of fleet management requirement. Teltonika Telematics products can be connected seamlessly with OpenRemote, with industry-first complete, automatic payload recognition and full support for all Teltonika Telematics devices.
 

diff --git a/docs/user-guide/anomaly-detection.md b/docs/user-guide/anomaly-detection.md
@@ -19,22 +19,22 @@ Currently there are 3 different types of detection methods you can use when conf
 
 ## Range
 This is the simples method to detect an outlier. To validate a datapoint it will look at a period of time before that datapoint, find the highest and lowest value and add an error margin on top of those values. These new minimum and maximum values will be the limit in which an point will be valid and any value outside these boundaries will be marked as an anomaly. The error margin and period of time the detection method uses can both be changed when configuring the method.
-![image](https://github.com/openremote/openremote/assets/79635315/88a040bf-022f-44be-a329-d498389c8dab)
+![image](img/anomaly-range.png)
 _Visualization of the limits generated by the Range method_
 
 The advantage of this method is that it's easy to understand but can still detect the larger outliers. However it falls short when detecting a big increase during a time where the data is already far below the maximum value.
 
 
 ## Change
 The change method works in a similar way to the Range method. It also looks at a previous period of data but instead of checking the value of the datapoints it calculates the difference between all points to get the largest increase and decrease in that period. Using these largest changes in the data it will calculate the limits for the next incoming datapoint using the last known value as a starting point.
-![image](https://github.com/openremote/openremote/assets/79635315/f7a2ae45-1e60-469b-8029-e0d8d6ffee9a)
+![image](img/anomaly-change.png)
 _Visualization of the limits generated by the Change method_
 
 This method will follow the data more closely as seen in the visualization above but needs more careful configuration to ensure it wont detect to to many false anomalies. 
 
 ## Forecast
 If the attribute you are configuring already has predicted datapoints, this will be the easiest method to set up. When new data is received it is compared to predicted datapoints from that time and if the difference is larger as a limit you can configure yourself it will be marked as an anomaly.
-![image](https://github.com/openremote/openremote/assets/79635315/80373795-303f-45a2-99de-5f09b553539c)
+![image](img/anomaly-forecast.png)
 _Visualization of the limits generated by the Forecast method_
 
 This accuracy of this method is dependent on the quality of the predicted data. This can come from different sources like OpenRemote's build in [Forecasting service](rules-and-forecasting/forecasting.md)

diff --git a/docs/user-guide/deploying/configuring-the-manager-ui.md b/docs/user-guide/deploying/configuring-the-manager-ui.md
@@ -496,4 +496,4 @@ Set which assettypes are excluded from the list of asset types that can be selec
 }
 ```
 This is what the --or-app-colors look like in the demo deployment:
-![Default colors in OpenRemote](https://openremote.io/wp-content/uploads/2021/04/coloruse-04.jpg)
+![Default colors in OpenRemote](img/or-app-colors.jpg)
diff --git a/docs/user-guide/deploying/img/or-app-colors.jpg b/docs/user-guide/deploying/img/or-app-colors.jpg
diff --git a/docs/user-guide/domains/create-your-energy-management-system.md b/docs/user-guide/domains/create-your-energy-management-system.md
@@ -10,7 +10,7 @@ OpenRemote can be used as an Energy Management System (EMS) for your own microgr
 
 In this electricity example, we will connect a series of electricity producers: solar panels and a wind turbine, an electricity consumer: an energy meter, a static battery, and a charger with an electric vehicle. We are adding the forecasting services for both production and consumption and connecting the agile supplier tariffs. Finally, the optimisation service will control the setpoint power of the battery, as well as the vehicle and calculate your savings. 
 
-<kbd>![Overview EMS](https://github.com/openremote/openremote/assets/11444149/f4d31d73-8649-4b72-baa3-0934483f9449)</kbd>
+<kbd>![Overview EMS](img/overview-ems.jpg)</kbd>
 _Figure 1. Overview of Energy Management System and all the elements._
 
 ### Set up OpenRemote and customisation
@@ -33,24 +33,24 @@ An optimisation asset represents the optimisation service. It will take into acc
 
 We are first adding the (renewable) energy production, by adding a PV solar Asset (Your solar) and a Wind turbine Asset (Your wind). Both need to be added as children of the Optimisation Asset. These assets include a series of standard attributes as shown in figure 2 and 3.
 
-<kbd>![Solar Asset](https://github.com/openremote/openremote/assets/11444149/5ba51ca9-43c2-47c3-a0b3-328251ad8c2e)</kbd>
+<kbd>![Solar Asset](img/solar-asset.png)</kbd>
 _Figure 2. The PV Solar asset (Your solar) with the respective attributes._
 
-<kbd>![Wind Asset](https://github.com/openremote/openremote/assets/11444149/9df9bd3d-f90a-4d18-9352-254c3a9349e0)</kbd>
+<kbd>![Wind Asset](img/wind-asset.png)</kbd>
 _Figure 3. The Wind Turbine Asset (Your wind) with the respective attributes._
 
 #### PV Solar Asset
 
 To configure and connect your PV Solar asset to your own solar system you can use the Agents. Most importantly you need to connect the actual power (the attribute called power) and the energy meter value (the attribute called energy export total). In this example we connect a solar system from Solar Edge. 
 First add an HTTP Agent and configure the Base URI and the Request Headers to connect to your Solar Edge system (see figure 4). 
 
-<kbd>![SolarEdge HTTP Agent](https://github.com/openremote/openremote/assets/11444149/0925e3a5-6921-4568-8f15-e2e8f7aeabf9)</kbd>
+<kbd>![SolarEdge HTTP Agent](img/solaredge-http-agent.png)</kbd>
 _Figure 4. The HTTP Agent, configured to connect to Solar Edge._
 
 Secondly, select your solar asset, select 'Modify' (on the upper right of the asset page) and connect the power attribute of the PV Solar Asset to this Agent. To do this uncollapse the power attribute, add the configuration item 'agent link', and add the required parameters (see figure 5). Also add the configuration items 'Rule state' (so you can use the attribute in rules) and 'Read only' (so you can't accidentally write a value in the 'VIEW' mode). Note the +/- sign convention, relevant for the optimisation to work: we use + for consumption and - for production. So in this case, as we are looking at power production, the power values should be negative. 
 In a similar manner you can connect the 'Energy export total' attribute to the energy meter value.  
 
-<kbd>![Solar Agent link](https://github.com/openremote/openremote/assets/11444149/95bd1f1b-a78d-4acb-9c48-4887aa481037)</kbd>
+<kbd>![Solar Agent link](img/solar-agent-link.png)</kbd>
 _Figure 5. The connection of the power attribute in your solar asset, using 'Agent link'._
 
 ##### Forecast service
@@ -147,7 +147,7 @@ In some cases you also want to connect to your charger, and make the vehicle a c
 * In case you can't control the power setpoint on your vehicle. You will need to link the 'Power setpoint' of your charger to your charging system, using any of the existing [Agent Protocol options](../agents-protocols/overview.md). In addition you can use the 'Flow editor' to link the 'Power setpoint' of your vehicle to the 'Power setpoint' of your charger. The optimisation will now set the 'Power setpoint' of your vehicle, which will then be forwarded to the 'Power setpoint' of your charger.
 * In case you want the optimisation to consider both the 'Power import max' of your charger as well of the vehicle, to take the lowest of the two for the 'Power setpoint'. 
 
-<kbd>![Energy schedule JSON format](https://github.com/openremote/openremote/assets/11444149/66427609-c63f-42d3-b66d-f65331a9b673)</kbd>
+<kbd>![Energy schedule JSON format](img/energy-schedule-json-format.png)</kbd>
 
 _Figure 6. The Energy schedule is in a JSON format as shown. Each day of the week (seven days) specifies the required energy level percentage for each hour of the day, starting at midnight. So in the above example the vehicle battery needs to be charged to 90% at 8am on each day_
 
@@ -161,11 +161,11 @@ In this tutorial we just simulate values by adding a simulator profile. To do th
 * Add the Parameter 'Replay Data' to 'Agent link' (see figure 7) 
 * Fill in the prices you want to use per time stamp. Note these are costs, so usually positive for import tariffs and negative for export tariffs (see figure 8 for an example).
 
-<kbd>![Replay data within Agent link](https://github.com/openremote/openremote/assets/11444149/5d77905e-b4f2-43f1-a9ea-1c03789c23a2)</kbd>
+<kbd>![Replay data within Agent link](img/replay-data-within-agent-link.png)</kbd>
 
 _Figure 7. Selecting the parameter 'Replay data' within the 'Agent link' configuration item_
 
-<kbd>![Supplier tariff export](https://github.com/openremote/openremote/assets/11444149/0065478d-a287-4d18-946a-bf18e0290e6e)</kbd>
+<kbd>![Supplier tariff export](img/supplier-tariff-export.png)</kbd>
 
 _Figure 8. An example for the 'Replay data' for the Export tariff you want to use, indicating a tariff per timestamp (seconds). The negative value indicates you are earning money_
 
@@ -184,7 +184,7 @@ You have now set everything to run your optimisation. Once optimisation is enabl
 * Take the Energy level schedule of your vehicle into considerations as well as their Energy level percentage min, and always take care that the energy levels are met in time.
 * Prioritise the different batteries, in this case your static battery and your vehicle, based on the so called Levelised cost of Storage (LCOS). LCOS is the additional costs of charging or discharging a battery. It reflects the costs of your battery divided by the capacity times the maximum number of charging cycles, so representing an amortisation. This can be implemented by adding the optional attributes 'Tariff import' and 'Tariff export' to your Electric vehicle asset and your Battery. Note that you should keep the 'Tariff import' value for your vehicle at '0' as charging your vehicle is anyhow required to be able to drive, and the optimisation will not introduce extra charge cycles. We haven't included this in our tutorial and recommend to read-up expert articles before applying. 
 
-<kbd>![EMS asset tree](https://github.com/openremote/openremote/assets/11444149/6b37d6d5-aa4a-45f6-80cd-64a637c8cb28)</kbd>
+<kbd>![EMS asset tree](img/ems-asset-tree.png)</kbd>
 
 _Figure 9. The asset tree of your EMS on the left, with the Optimisation asset selected_
 

diff --git a/docs/user-guide/domains/img/ems-asset-tree.png b/docs/user-guide/domains/img/ems-asset-tree.png
diff --git a/docs/user-guide/domains/img/energy-schedule-json-format.png b/docs/user-guide/domains/img/energy-schedule-json-format.png
diff --git a/docs/user-guide/domains/img/overview-ems.jpg b/docs/user-guide/domains/img/overview-ems.jpg
diff --git a/docs/user-guide/domains/img/replay-data-within-agent-link.png b/docs/user-guide/domains/img/replay-data-within-agent-link.png
diff --git a/docs/user-guide/domains/img/solar-agent-link.png b/docs/user-guide/domains/img/solar-agent-link.png
diff --git a/docs/user-guide/domains/img/solar-asset.png b/docs/user-guide/domains/img/solar-asset.png
diff --git a/docs/user-guide/domains/img/solaredge-http-agent.png b/docs/user-guide/domains/img/solaredge-http-agent.png
diff --git a/docs/user-guide/domains/img/supplier-tariff-export.png b/docs/user-guide/domains/img/supplier-tariff-export.png
diff --git a/docs/user-guide/domains/img/wind-asset.png b/docs/user-guide/domains/img/wind-asset.png
diff --git a/docs/user-guide/gateways-and-devices/auto-provisioning.md b/docs/user-guide/gateways-and-devices/auto-provisioning.md
@@ -43,7 +43,7 @@ Jump to:
 
 The following illustrates the connect process (through [MQTT topics](../manager-apis/manager-apis.md#mqtt-api-mqtt-broker)) which clients can use to auto provision a service user and optionally an asset whose ID is generated using a UNIQUE_ID provided by the client; the client is then authenticated and the asset is then returned to the client.
 
-<kbd>![Auto provisioning Connect flow](https://github.com/openremote/openremote/assets/11444149/f8f0eccf-e22e-4b3f-a410-b0d42e2b6a91)</kbd>
+<kbd>![Auto provisioning Connect flow](img/auto-provisioning-connect-flow.png)</kbd>
 
 **NOTE THAT THE 'WHITELIST/BLACKLIST FAILURE', IS NOT YET IMPLEMENTED. THIS FUNCTION ENHANCES SECURITY AS ONLY SPECIFIED DEVICES CAN CONNECT (WHITELIST) OR CAN BE EXLUCDED (BLACKLIST)**
 
@@ -253,7 +253,7 @@ awk ‘NF {sub(/\r/, “”); printf “%s\n”,$0;}’
 1. Create then select an asset of the same type that you want to use in the template then select the asset ID from the address bar (e.g. `https://staging.demo.openremote.io/manager/?realm=smartcity#/assets/false/2K3nSg148fnzlSlaem0kkh` -> `2K3nSg148fnzlSlaem0kkh`)
 1. Navigate to swagger UI (https://your_installation/swagger e.g. https://staging.demo.openremote.io/swagger)
 1. Click authorize then again on the popup dialog then login with a user from the master realm
-1. Once authenticated go to `Assets -> Get /asset/{assetId}` and paste the asset ID into the asset ID input then execute the query, you will then get the asset returned in `json` format: ![image](https://user-images.githubusercontent.com/7072278/145991791-e0a5cfd9-f989-4fe3-9d72-cc2178812202.png)
+1. Once authenticated go to `Assets -> Get /asset/{assetId}` and paste the asset ID into the asset ID input then execute the query, you will then get the asset returned in `json` format: ![image](img/get-asset-request.png)
 1. You can copy the returned `json` and paste that into the `Asset template` input field:
    1. Remove or set the the `parentId` to determine where in the asset tree the asset will be created
    1. remember to insert the `%UNIQUE_ID%` placeholder wherever you would like that to be used (in an attribute value, in the asset name, etc.)