Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated jfrontend.rst #20

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Updated jfrontend.rst #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 42 additions & 44 deletions docs/source/frontends/jfrontend.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ Jfrontend
Environments
############

Change renderer
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It becomes redundant. Hence, removed "Change renderer" because the heading is already provided below each image.

***************
This frontend supports different renderers.

.. figure:: images/jfrontend/renderer/change-renderer.png
Expand Down Expand Up @@ -64,68 +62,68 @@ This frontend supports different renderers.

Change background images
************************
Go to menu **Edit** -> **Environment** -> **Change Background** and select a PNG or JPG file.
Go to menu **Edit** -> **Environment** -> **Change Background** and select a PNG or a JPG file.


Add a new room
**************
To add a new room click on menu **Edit** -> **Room Edit Mode (F5)** and then **Edit** -> **Environment** -> **Add Room**.
A new square polygon is created on the left top corner of the environment. Now you can drag the blue handles to position the room correctly on the map.
To add a new room, click on menu **Edit** -> **Room Edit Mode (F5)** and then **Edit** -> **Environment** -> **Add Room**.
A new square polygon will be created on the top left corner of the environment. Now you can drag the blue handles, to position the room correctly on the map.

Rename a room
*************
To rename a room click on **Edit** -> **Environment** -> **Rename Room** and digit the new name into the dialog box.
To rename a room, click on **Edit** -> **Environment** -> **Rename Room** and enter the new name into the dialog box.

Delete a room
*************
To delete a room select it by clicking on it then choose **Edit** -> **Environment** -> **Remove Room**.
To delete a room select it by clicking on it, then choose **Edit** -> **Environment** -> **Remove Room**.


Edit room shape
***************
To edit the map simply click on menu **Edit** -> **Room Edit Mode (F5)**. Now you can drag the blue handles around to edit rooms shape.
The measures are in centimeters. When you are satisfied with your changes disable the edit mode in menu **Edit** -> **Room Edit Mode (F5)**.
To edit the map, simply click on menu **Edit** -> **Room Edit Mode (F5)**. Now you can drag around the blue handles, to edit the room's shape.
The measures are in centimeters. When you are satisfied with your changes, disable the edit mode in menu **Edit** -> **Room Edit Mode (F5)**.

To add new handles double click on a preexistent one. To remove an handle right-click on it.
To add new handles, double click on a pre-existent one. To remove any handle, right-click on it.


Things
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replaced "Things" with "Objects" everywhere. It seems to be more proper.

Objects
######

Move things
Move objects
***********
From menu **Edit** -> **Objects Edit Mode (F6)** you can drag & drop furnitures around the environment.

Configure things
Configure objects
****************
Right click on a thing will prompt its configuration dialog.
Right clicking on an object will prompt its configuration dialog.


How to add things to the environment map
How to add objects to the environment map
****************************************
Here you have two options.

#. Add it from the toolbar: click on menu **Edit** -> **Objects Edit Mode** or press **F6**. Now you see the list of things you can add to your environment. Simply right click on it and choose **Add to environment**. Press F6 again to come back to view mode.
#. Clone an already existent thing on the map: select one, right click on it, go to **Properties** tab and press **Create a Copy** button.
#. Add it from the toolbar: click on menu **Edit** -> **Objects Edit Mode** or press **F6**. Now you can see the list of objects you can add into your environment. Simply right click on it and choose **Add to environment**. Press F6 again to come back to view mode.
#. Clone an already existing object from the map: select the object, right click on it, go to **Properties** and press **Create a Copy** button.

A new thing of the same type will be created and placed in the left top corner of your environmnent. To know how to rename it and move read the next paragraph.
A new object of the same type will be created and placed in the top left corner of your environmnent. To know how to rename it and move, read the next paragraph.

How to customize the things icons
How to customize the object icons
*********************************
Things icons are stored in *FREEDOMOTIC_FOLDER/data/resources*. If you want to edit a thing icon or create a completely new one firstly edit/create the png image used to represent the thing and put it in the folder mentioned above.
Object icons are stored in *FREEDOMOTIC_FOLDER/data/resources*. If you want to edit an object's icon or create a completely new one, firstly edit/create the png image used to represent that object and put it in the folder mentioned above.

Then you have to associate your icon with the thing. To do so right click on a thing and go to **Representation** tab. Click on **Change Image** button and select your custom image you put in the *FREEDOMOTIC_FOLDER/data/resources* folder.
Then you have to associate your icon with the object. To do so right click on an object and go to **Representation** tab. Click on **Change Image** button and select your custom image from the *FREEDOMOTIC_FOLDER/data/resources* folder.

Every thing behavior (on, off, etc...) can have a different icon to represent itself, so you have to repeat the operation for every representation you want to change.
To change the current behavior of an object go to the **Control** tab and use the controls to switch it, then you can change its icon for this behavior as explaned above.
Every object's behavior (on, off, etc...) can have a different icon to represent itself, so you have to repeat the operation for every representation you want to change.
To change the current behavior of an object, go to the **Control** tab and use the controls to switch it, then you can change its icon for this behavior, as explaned above.

Connect things to real devices
Connect objects to real devices
******************************
In Freedomotic thing are independent from the hardware you use to drive them. For example a light object is the same if you turn it on/off using OpenWebNet, Arduino, z-wave and so on.
In Freedomotic, objects are independent from the hardware you use to drive them. For example a light object is the same, if you turn it on/off using OpenWebNet, Arduino, z-wave and so on.

First be sure to have the right driver plugin installed. If not install it following the plugin specific instructions on its marketplace page.
Always be sure to have the right driver plugin installed. If not, then install it using the plugin's specific instructions given on its marketplace webpage.

To bind an object with a specific protocol you have to right click on the object to open its configuration dialog. Now go to the **Commands** tab and bind the object generic actions like ``turn on`` and ``turn off`` with the specific hardware command to execute it. For example a light ``turn on`` action can be bound with ``turn on OpenWebNet (OWN) light`` command selected from the list on the right.
To bind any object with a specific protocol, you have to right click on the object to open its configuration dialog. Now go to the **Commands** tab and bind the object to generic actions like ``turn on`` and ``turn off`` with the specific hardware command to execute it. For example a light ``turn on`` action can be bound with ``turn on OpenWebNet (OWN) light`` command selected from the list on the right.

.. figure:: images/jfrontend/things/thing-configuration.png
:width: 500px
Expand All @@ -134,14 +132,14 @@ To bind an object with a specific protocol you have to right click on the object
:alt: Connect a thing to a real device
:figclass: align-center

Connect a thing to a real device
Connect an object to a real device


Localization
############
Freedomotic can detect your pc configuration and set the correct language.

If it's not available or you choose the default value **auto** the software uses **English**.
If it's not available or you have chosen the default value **auto**, then the software uses **English**.

.. figure:: images/jfrontend/localization/languages.png
:width: 500px
Expand All @@ -150,15 +148,15 @@ If it's not available or you choose the default value **auto** the software uses
:alt: Freedomotic Multilanguage Support
:figclass: align-center

Multilanguage Support
Multi-lingual Support

Automations
###########
In Freedomotic automations are more powerful than simple timed turn on/off of objects. They can be created in nearly natural language (we are working on it) in the form ``if this happens then do that``.
In Freedomotic, automations are more powerful than simple, timed turn on/off of objects. They can be created in nearly any natural language (we are working on it) in the form ``if this happens, then do that``.

Event Driven Automations
************************
To create a new automation right click on the related object, switch to **Automations Tab** and start to write your command into the input box related to the trigger you desire for your command.
To create a new automation, right click on the related object, switch to **Automations Tab** and start to write your command into the input box related to the trigger you desire for your command.

For example:

Expand All @@ -171,12 +169,12 @@ Now the light turns on and off when you click it.

Time Driven Automations
***********************
For timed automations like ``every minute do that`` you will need a **Clock** object (if there isn't one on the map, add it by pressing F6 and double clicking on the **Clock** thing on the list on the left side of your screen).
For timed automations like ``every minute do that`` you will need a **Clock** object (if there isn't one on the map, add it by pressing F6 and double clicking on the **Clock** object on the list, on the left side of your screen).

Then right click on your new object, switch to automations tab and create your automation the same way as the Event Driven Automations, just explained above, for example ``Switch power for all lights every 5 seconds``.
Then right click on your new object, switch to automations tab and create your automation, the same way as the Event Driven Automations, just explained above, for example ``Switch power for all lights every 5 seconds``.

Right click on the clock object and switch to **Automations Tab** or use the automations editor which lists all available triggers.
Find the trigger ``every 5 seconds`` and link to it the command ``switch power for all lights``.
Right click on the clock object and switch to **Automations Tab** or use the automations editor, which lists all the available triggers.
Find the trigger ``every 5 seconds`` and link it to the command ``switch power for all lights``.



Expand All @@ -185,8 +183,8 @@ Plugins

Download new features from the marketplace
******************************************
In **Plugins** menu choose **Install from marketplace**. After the list is updated (it can take up to a minute) you will see the list of plugins on the markeplace that are available for your current Freedomotic version.
To install one double click on it and follow the instructions.
In **Plugins** menu choose **Install from marketplace**. After the list is updated (it can take up to a minute) you will see the list of plugins in the markeplace that are available for your current Freedomotic version.
To install one, double click on it and follow the instructions.

.. figure:: images/jfrontend/plugins/install-from-marketplace.png
:width: 500px
Expand All @@ -200,8 +198,8 @@ To install one double click on it and follow the instructions.

Start and stop plugins
**********************
Loaded plugins are visible in the list on the left of the environment map. Running plugins are represented by a coloured icon.
To start a plugin (or stopping an already running one) simply double click on its name. When a plugin is running the feature it provides is available to the system.
Loaded plugins are visible in the list, on the left of the environment map. Running plugins are represented by a coloured icon.
To start a plugin (or stopping an already running one) simply double click on its name. When a plugin is running, the feature it provides is available to the system.
For example the OpenWebNet plugin enables communication with BTicino OpenWebNet (OWN) devices. This means the plugin doesn't provide automations to drive OWN devices itself but only "translates" the Freedomotic user commands as ``turn on kitcken light`` into hardware level specific commands. This way you could forget about hardware details and how they communicate internally, you simply say ``turn on kitchen light``, and Freedomotic takes care of the rest.

.. figure:: images/jfrontend/plugins/plugin-list.png
Expand All @@ -215,9 +213,9 @@ For example the OpenWebNet plugin enables communication with BTicino OpenWebNet

How to configure a plugin
*************************
Some plugins offer a configuration dialog to interact with its features. To show it simply right click on the plugin name.
For example you can try this on the **"Sensors Simulator"** plugins which is a development tool to simulate a temperature and luminosity sensor.
You can make this fake sensor notify a temperature change to Freedomotic moving the **temperature** slider.
Some plugins offer a configuration dialog to interact with its features. To view it, simply right click on the plugin name.
For example you can try this on the **"Sensors Simulator"** plugin, which is a development tool to simulate a temperature and luminosity sensor.
You can make this fake sensor notify a temperature change to Freedomotic, by moving the **temperature** slider.

.. figure:: images/jfrontend/plugins/sensors-simulator.png
:width: 500px
Expand All @@ -228,7 +226,7 @@ You can make this fake sensor notify a temperature change to Freedomotic moving

Simulator Plugin

.. note:: Not all plugins have a configuration dialog so if you right click and nothing shows is because this plugin have no configuration options.
.. note:: Not all plugins have a configuration dialog, so if you right click and nothing shows, it is because the plugin have no configuration options.


Settings
Expand Down