Qeedji SBL10e User manual

U ser manual
SBL10 e generic_ server
1.11.10 0 0 2A

2
Legal notice
SBL10 e generic_ server 1.11.10 ( 0 0 2A _ en)
© 2020 Qeedji
R ights and R esponsibilities
All rights reserved. No part of this manual may be reproduced in any form or by any means whatsoever. or by any means whatsoever without the
written permission of the publisher. The products and services mentioned herein may be trademarks and/or service marks of the publisher. or
trademarks of their respective owners. The publisher and the author do not claim any rights to these Marks.
Although every precaution has been taken in the preparation of this document, the publisher and the author assume no liability for errors or
omissions, or for damages resulting from the use of the information contained in this document or the use of programs and source code that can go
with it. Under no circumstances can the publisher and the author be held responsible for any loss of profits or any other commercial prejudice caused
or alleged to have been caused directly or indirectly by this document.
Product information
Product design and specifications are subject to change at any time and `Qeedji` reserves the right to modify them without notice. This includes the
hardware, the embedded software and this manual, which should be considered as a general guide to the product. The accessories supplied with the
product may differ slightly from those described in this manual, depending on the developments of the various suppliers.
Precautions for use
Please read and heed the following warnings before turning on the power: - installation and maintenance must be carried out by professionals. - do
not use the device near water. - do not place anything on top of the device, including liquids (beverages) or flammable materials (fabrics, paper). - do
not expose the device to direct sunlight, near a heat source, or in a place susceptible to dust, vibration or shock.
Warranty clauses
The `Qeedji` device is guaranteed against material and manufacturing defects for a certain duration. Check the device warranty duration value at the
end of the document. These warranty conditions do not apply if the failure is the result of improper use of the device, inappropriate maintenance,
unauthorized modification, operation in an unspecified environment (see operating precautions at the beginning of the manual) or if the device has
been damaged by shock or fall, incorrect operation, improper connection, lightning, insufficient protection against heat, humidity or frost.
WE E E Directive
This symbol means that your appliance at the end of its service life must not be disposed of with household waste, but must be taken to a collection
point for waste electrical and electronic equipment or returned to your dealer. Your action will protect the environment. In this context, a collection
and recycling system has been set up by the European Union.

3
1.1
1.1.1
1.1.2
1.1.3
1.1.4
1.2
2.1
3.1
3.1.1
3.1.2
3.1.3
3.1.4
3.1.5
3.1.6
3.1.7
3.1.8
3.1.9
3.1.10
3.1.11
3.1.12
4.1
4.2
5.1
6.1
6.2
T able of contents
Part I : Description and installation
Introduction
Device dimensions
Labelling
Installation
Uninstallation
Smart Busy Light applications
Part II : A pplicative user interface
Applicative user interface
Part III : A dministration console user interface
Administration console user interface
Configuration > Administrator
Configuration > LAN
Configuration > Servers
Configuration > Date and time
Configuration > Tasks
Maintenance > Firmware
Maintenance > Preferences
Maintenance > Logs
Maintenance > Tools
Maintenance > Files
Information > Device
Information > Network
Part IV : T echnical information
Technical specifications
Conformities
Part V : Contacts
Contacts
Part V I : A ppendix
Appendix: Web services
Appendix: Qether

4
Part I Description and installation

5
1.1Introduction
This manual explains how to install and configure your device SBL10e.
R ecommendations and warnings
This device is designed for indoor use only.
To ensure better rendering of the SBL10e, the device should not be installed under direct sunlight.
The SBL10e device is designed to be illuminated 12 hours a day, 7 days a week.
Pack age Contents
A rticles Description
Device SBL10e device with the default regular ¹ application embedded.
¹ It is possible to easily update the device with the generic_server application afterwards.

6
1.1.1Device dimensions

7
1.1.2Labelling
Product label
The model of the device, the power supply characteristics, the serial number (PSN) and the MAC address are written on a label stuck on the case.
☛ The Q R code on the product label is corresponding to the product identification URL, for example:
i.q eedj i.tech? model=S B L 10e& sn=01320-00009& mac.lan1=00-1C -E 6-02-4C -E C & mac.wpan1=D F -27 -83-3C -8A -90 .
Pack ingbox label
This is the label stuck also on the packingbox. It is showing:
the device model,
the product serial number (PSN) (embedded also in the QR code),
the manufacturer Web site.
☛ The Q R code on the packingbox label is corresponding to the product PSN, for example:
P S N 01320-00009 C D 1 .
☛ The serial number of the device could be req uested in case of technical support.

8
1.1.3Installation
☛ Install the SBL10e device on the E thernet wall plugs of the buildings following the installation map given by your IT departement.
The SBL10e device has to be plugged to an Ethernet wall plug supporting PoE IEEE802.3af.
G iven the device footprint, it is preconised to use Ethernet wall plug plastron with a right insertion.
Consequently, the Ethernet wall plug whose plastron is angled is not supported.
☛ Thanks to the lock pin of its E thernet connector, the SBL10e device can be installed on vertical surfaces, like walls as well as horiz ontal
surfaces, like ceilings.

9
1.1.4U ninstallation
With a screw driver, hold down the pin of the Ethernet connector 1 of the SBL10e device at the same time you are releasing with the hand 2 the
SBL10e device from the Ethernet wall plug.
1
2

10
1.2Smart Busy Light applications
To display the appropriate light state and color, the generic_server application periodically connects to a Web server supporting a database of the
different state and color values for each SBL10e installed in the organization.
Server datasource
The server datasource must fill these requirements in terms of Web service and data format.
Web service:
This is the format of the H TTP request sent by application running on SBL10e to the datasource server to get its appropriate light state and color:
G E T / <URL> H TTP/1.0
H ost: <server_address>
with <URL> = https://<domain_name>:<port>/<path>
For example:
G E T https://192.168.10.10:443/webdir/00900-01504 H TTP/1.0
H ost: 192.168.10.10
Data format:
The body of the data returned for each SBL10e by the server datasource must be formatted in J SO N format. The J SO N body is built with the following
way:
{ "state": "<state>", "color": "<color>" }
These are the supported values for each variable:
<state> : off, steady or fl ashing,
<color> : red, orange, blue, yellow or green
Example:
{ "state": "steady", "color": "red"}
Light states and colors
The SLB10e can support the states and colors values showed below.
Color State
OFF
Red ON steady or ON flashing
Green ON steady or ON flashing
Blue ON steady or ON flashing
Orange ON steady or ON flashing
Yellow ON steady or ON flashing
☛ The O N flashing state is fl ashing with this seq uence: O N for 0,5 seconds then O F F for 0,5 seconds every one second.
☛ D epending on the application running on it, some color/state may be never used.
☛ The light color and state values are stored in the volatile memory (RAM). That means that in case the SBL10e device is unplugged from the
E thernet wall plug then plugged back again, the light comes back to its default state: O F F .

11
Configuration
The Smart Busy Light application supports the configuration update:
by connecting to the Administration console user interface http://<device-ip-addr>/ and changing parameters,
by pushing, from a WebDAV client or with the device Web user interface, a prefs.json configuration file on the device WebDAV directory
http://<device-ip-addr>/.conf/ ,
by pushing, from a WebDAV client or with the device Web user interface, a .js configuration script on the device WebDAV directory
http://<device-ip-addr>/.conf/ ,
by receiving a configure command with an appropriate .js configuration script from the Qether tool (Qether V 1.12.10 or above).
Firmware upgrade
The Smart Busy Light application supports the firmware upgrade:
by connecting to the Administration console user interface http://<device-ip-addr>/ and loading an appropriate firmware file
bm0032_generic_server-sbl10e-xx.yy.zz.bin ¹ firmware file,
by pushing a new bm0032_generic_server-sbl10e-xx.yy.zz.bin ¹ firmware file at the root of the device WebDAV directory http://<device-ip-addr>/ ,
pushed with a WebDAV client,
by receiving an install command with an appropriate bm0032_generic_server-sbl10e-xx.yy.zz.bin ¹ firmware file from the Qether tool.
¹ Can work also with any other bm0032_<custom>-sbl10e-x x .y y .z z compatible firmware.
☛ After a firmware upgrade, the device is rebooting once.
☛ When the configuration command or the install command has been processed, the last S mart B usy L ight state and color are restored.
Preprogrammed flashing sequence
The SBL10e device has two modes:
Nominal mode : the Smart Busy Light application runs properly and sets the light state and color as expected. When a configuration or a firmware
upgrade is in progress, the light illumination can be temporarily inconsistent and follows the light flashing sequence shown in the table hereafter.
Recovery mode : the Smart Busy Light application can not be executed. The light state or color can not be modified anymore. It is required to
update the firmware to return to the nominal mode .

12
Depending on these modes, the Smart Busy Light applications can fall into one of these preprogrammed flashing sequences:
Mode Smart Busy light
behaviour Information
R ecovery
2 very short and
consecutive blue
flashs (250 ms) with
a 4,5 seconds
periodicity
The Smart Busy Light application can not be executed (it should never occur). The device Web user
interface is so not available. This sequence is displayed until a new firmware update is realized with
Qether tool. For further information, contact support@ qeedji.tech.
R ecovery
3 very short and
consecutive blue
flashs (250 ms) with
a 5 seconds
periodicity
The software resource of the SBL10e device set at factory are not valid. It should never occur. For further
information, contact support@ qeedji.tech.
Nominal
or
recovery
4 very short and
consecutive blue
flashs (250 ms) with
a 5,5 seconds
periodicity
A SBL10e device Firmware update is in progress. Please wait a couple of seconds.
Nominal 5 very short and consecutive blue
flashs (150 ms) A SBL10e device configuration is in progress. Please wait a couple of seconds.
Nominal 6 very short and consecutive blue
flashs (150 ms)
The datasource is not consistent because some of the parameters are missing or have a wrong value.
For further information about the datasource form, refer to the chapter chapter § Configuration >
Servers. For further information about the reporting of the problems faced with some datasource
parameters, refer to the chapter § Maintenance > Logs.

13
Part II A pplicative user interface

14
2.1A pplicative user interface
The SBL10e device has a Web user interface that can be accessed with a Web browser. The supported Web browsers are: Google C hrome , M ozilla
Firefox , M S-E dge ( C hromium) .
It is available from the UR L: http://<device_I P _addr>/ .
By default, the login credentials for the device Web user interface are:
login: admin ,
password: admin .
The UR L falls into the generic_server applicative user interface: http://<device_I P _addr>/webui/ . This pane allows to:
watch the current light color,
watch the current light state.

15
Part III A dministration console user interface

16
3.1A dministration console user interface
The SBL10e device has a Web user interface that can be accessed with a Web browser. The supported Web browsers are: Google C hrome , M ozilla
Firefox , M S-E dge and M S-E dge ( C hromium) .
It is available from the UR L: http://<device_I P _addr>/ .
By default, the login credentials for the device Web user interface are:
login: admin ,
password: admin .
The UR L falls automatically into the applicative user interface¹ . At the top right corner, click on the Administration C onsole button.
¹ F or further information, refer to the chapter § Applicative user interface.
This is the Administration console user interface.
◬ After you have changed and saved all your settings in the different panes, be sure to perform a device restart by clicking on the Reboot the
device 2 button so that your changes are fully reflected.
Click on the device logo 1 at the left top corner to return to the applicative user interface.
1
2

17
3.1.1Configuration > A dministrator
In the C onfiguration pane, select the A dministrator menu to change:
the H ostname ,
the login credentials:
Administrator name ,
P assword .
For security reasons, it may be useful to change the login credentials to access to the device' s Web user interface. Please keep these login credentials
in a safe place afterwards.
☛ The same login credentials are used to access to the WebD AV server.
☛ It is recommended that you enter one uniq ue Hostname value for each device. In case several SBL10e devices are located in different buildings
or geographical locations, we recommend that you enter hostname values with information about the building and the location (e.g. Hall-R D -
P aris-1 ).
☛ A blanck screen could be displayed after having refreshed rapidly and sereral times the Web user interface. To work around, wait a doz en of
seconds, and refresh again the Web user interface.

18
3.1.2Configuration > LA N
In the C onfiguration pane, select the LA N menu to set up the network configuration of the LAN interface of your device.
☛ The device supports the UPnP and can be for example detected in the local network environment of your computer.
☛ When only the T ime for attempts value is modified, press on TAB key to make appear the Validate button.
☛ By default, the device is configured with D H CP activated. In the default configuration, in case the D H CP is unavailable, after the T ime for
attempts (10 minutes, maximum and default value) has expired, the device ends up using the static IP address entered in the LAN configuration.
The static IP address is 19 2.168 .0.2 when it has not been changed yet by the end user. It is recommended to set an appropriate IP address,
netmask and gateway if this case would happen. When D H CP is activated and T ime for attempts is unchecked, the device never falls into a LAN
configuration with a static IP address. As soon as the server D H CP becomes available, the device ends by getting back a valid IP address given by
the D H CP server.

19
3.1.3Configuration > Servers
In the C onfiguration pane, select the Servers menu to define the configuration of the servers peripheral to your device.
The D atasource Server is the server machine having the dynamic information of the current state and color to apply to your busylight:
D atasource Server :
URL : enter the UR L² including the port of your D atasource Server (only the https scheme is supported) ,
C redential
checked:
default type: Username/Password,
username : username to access to the server,
password : password to access to the server,
unchecked (default value): no username/password is required,
H eartbeat : periodicity of the connection to the D atasource Server , from 2 seconds (default value) to 120 seconds.
H T T P S proxy server :
Address : enter the IPv4 address, or the domain name of your proxy server,
P ort : enter the operating port of your proxy server,
D NS servers ,
NT P time server .
☛ The generic_server application can work even if the NTP time server is not set.
☛ The login credentials inside the URL are not supported, i.e. https://user1:[email protected]:443/webdir/01320-00550 .
☛ If the server is not available after 20 (default value stored in the appli.network.datasource.nb_retries_before_cache_reset user preference)
consecutive unsuccessful connection attempts, the light is switched Off until the next successful connection attempt.
☛ When only the Heartbeat value is modified, press on TAB key to make appear the Validate button.
² The URL has to match the directory of your database. If you have more than one SBL10e device to control, it is advised to implement one directory per
SBL10e with the directory name matching either the device PSN, or the device MAC address, i.e.: https://192.168.10.10:443/webdir/01320-00550 with
01320-00550, an example of PSN value from a SBL10e device, or https://192.168.10.10:443/webdir/00-1c-e6-02-4c-ad with 00-1c-e6-02-4c-ad, an
example of MAC address value from a SBL10e device.
To put the same UR L for all your SBL10e datasource inputs, you can use two kind of variable values intrinsic to the device:
V ariable type String to set in the input V alue ex ample
deviceInfo:mac variable {$ deviceI nfo:mac} 00-1c-e6-02-4c-ad³
deviceInfo:psn variable {$ deviceI nfo:psn} 01320-00550
³ The format with double dot instead of dash is not supported when using {$deviceInfo:mac} variable (i.e.: 00:1c:e6:02:4c:ad).
The UR L would be for example:
https://192.168.1.4 1:4 4 3/webdir/{$ deviceI nfo:mac} or,
https://192.168.1.4 1:4 4 3/webdir/{$ deviceI nfo:psn} .
For further information about the device PSN value, refer to the chapter § Information > Devices. For further information about the device MAC value,
refer to the chapter § Information > Network.
◬ Upgrading the SBL10e device with another application type will clear the current datasource configuration data. When the SBL10e is
properly configured, it is advised to build and save an appropriate SBL10e configuration script ( .js ) by using the configuration script template
or save at least the prefs.json configuration file of your SBL10e device. For further information, refer to the chapter § Maintenance > Files.

20
3.1.4Configuration > Date and time
From the C onfiguration pane, select the Date and T ime menu to check the time configuration:
timezone,
system date of your device (day and time).
☛ The application can work even if the device is not on time.