Qeedji SBL10e User manual

User manual 001A
SBL10e
smart_office_obs-1.10.11

2
Legal noce
SBL10e smart_office_obs-1.10.11 (001A_en)
© 2020 Qeedji
Rights and Responsibilies
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 wrien permission of the
publisher. The products and services menoned herein may be trademarks and/or service marks of the publisher. or trademarks of their respecve owners. The publisher and the
author do not claim any rights to these Marks.
Although every precauon has been taken in the preparaon of this document, the publisher and the author assume no liability for errors or omissions, or for damages resulng
from the use of the informaon 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 informaon
Product design and specificaons are subject to change at any me and `Qeedji` reserves the right to modify them without noce. This includes the hardware, the embedded
soware 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.
Precauons for use
Please read and heed the following warnings before turning on the power: - installaon 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 suscepble to dust, vibraon or shock.
Warranty clauses
The `Qeedji` device is guaranteed against material and manufacturing defects for a certain duraon. Check the device warranty duraon value at the end of the document. These
warranty condions do not apply if the failure is the result of improper use of the device, inappropriate maintenance, unauthorized modificaon, operaon in an unspecified
environment (see operang precauons at the beginning of the manual) or if the device has been damaged by shock or fall, incorrect operaon, improper connecon, lightning,
insufficient protecon against heat, humidity or frost.
WEEE Direcve
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 collecon point for waste electrical and
electronic equipment or returned to your dealer. Your acon will protect the environment. In this context, a collecon and recycling system has been set up by the European Union

3
1.1
1.1.1
1.1.2
1.1.3
1.2
1.2.1
2.1
2.1.1
2.1.2
2.1.3
2.1.4
2.1.5
2.1.6
2.1.7
2.1.8
2.1.9
2.2
3.1
3.2
4.1
Table of contents
1 - Descripon and installaon
Introducon
Device dimensions
Labelling
Installaon
Smart Busy Light applicaons
Web services
2 - Configuraon
Configuraon Web interface
Configuraon > Administrator
Configuraon > LAN
Configuraon > Servers
Maintenance > Firmware
Maintenance > Preferences
Maintenance > Tools
Maintenance > Files
Informaon > Device
Informaon > Network
Recovery by Qether
3 - Technical informaon
Technical specificaons
Conformies
4 - Contacts
Contacts

4
1.1 Introducon
This manual explains how to install and configure your device SBL10e.
Recommendaons and warnings
This device is designed for indoor use only.
To ensure beer rendering of the SBL10e, the device should not be installed under direct sunlight.
The SBL10e is designed to be illuminated 12 hours a day, 7 days a week.
Package Contents
Arcles Descripon
Device SBL10e with the default regular ¹ applicaon embedded.
¹ It is possible to easily update the device with the smart_office_obs applicaon aerwards.

5
1.1.1 Device dimensions
60,47 mm
(2,38")
18,20 mm
(0,70")
47,56 mm
(1.87")

6
1.1.2 Labelling
☛ The serial number of the device can be requested in case of technical support.
The model of the device, the power supply characteriscs, the serial number (PSN) and the MAC address are wrien on labels which are stuck on the case.
This is the label stuck also on the cardbox. It is showing:
the device model,
the product serial number (PSN) (embedded also in the QR code),
the manufacturer Web site.

7
1.1.3 Installaon
☛ Install the SBL10e device on the Ethernet wall plugs of the buildings following installaon plan given by your IT departement.
The SBL10e device has to be plugged to a Ethernet wall plug supporng PoE IEEE802.3af.
Given the device footprint, it is preconised to use Ethernet wall plug plastron with a right inseron.
Consequently, the Ethernet wall plug whose plastron is angled is not supported.
☛ Thanks to the pin of its Ethernet connector, the SBL10e can be installed on vercal surfaces, like wall as well as horizontal surfaces, like ceilings.
1.1.3 Uninstallaon
Hold down the pin of the Ethernet connector of the SBL10e at the same me you are releasing the SBL10e from the Ethernet wall plug.
RJ45

8
1.2 Smart Busy Light applicaons
The smart_office_obs applicaon periodically connects to a datasource server to retrieve and display the appropriate light state and color. The applicaon can easily be replaced
by another one. For further informaon, refer to the chapter § Maintenance > Firmware.
Light states and colors
The Smart Busy Light applicaons support these states and colors:
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 ON flashing state is flashing ON for 0,5 seconds then OFF for 0,5 seconds every one second.
☛ The light color and state values are stored in the volale memory (RAM). That means that in case the SBL10e device is unplugged from the Ethernet wall plug then
plugged back again, the light comes back to its default state: OFF .
Configuraon
The Smart Busy Light applicaon supports the configuraon update:
by connecng to the configuraon Web interface http://<device-ip-addr>/ ,
when pushing, with a WebDAV client, a prefs.json configuraon file on the device WebDAV directory http://<device-ip-addr>/.conf/ ,
when receiving a configure command from the Qether tool.
Firmware upgrade
The Smart Busy Light applicaon supports the firmware upgrade:
by connecng to the configuraon Web interface http://<device-ip-addr>/ and loading an appropriate firmware file bm0032_smart_office_obs-sbl10e-xx.yy.zz ¹,
by pushing a new firmware file bm0032_smart_office_obs-sbl10e-xx.yy.zz ¹ at the root of the device WebDAV directory http://<device-ip-addr>/ , pushed with a WebDAV
client,
by receiving an install command from the Qether tool.
¹ Can work also with any other compable firmware bm0032_<custom>-sbl10e-xx.yy.zz .
☛ Aer a firmware upgrade, the device is reboong once.
☛ When the configuration command or the install command has been processed, the last Smart Busy Light state and color are restored.
Preprogrammed flashing sequence
The SBL10e device has two modes:
Nominal mode : the Smart Busy Light applicaon runs properly and sets the light state and color as expected. When a configuraon or a firmware upgrade is in progress, the
light illuminaon can be temporarily inconsistent and follow the light flashing sequence below.
Recovery mode : the Smart Busy Light applicaon can not be executed. The light state or color can not be modified anymore. It is required to update the firmware to return
to nominal mode.
Depending on these modes, the Smart Busy Light applicaons can fall into one of these a preprogrammed flashing sequences in some specific cases:
Mode Smart Busy light behaviour Informaon
Recovery
2 very short and consecuve
blue flashs (250 ms) with a 4,5
seconds periodicity
The Smart Busy Light applicaon can not be executed (it should never occur). The configuraon Web interface is so
not available. This sequence is displayed unl a new firmware update realized with Qether tool. For further
informaon, contact support@qeedji.tech.
Recovery
3 very short and consecuve
blue flashs (250 ms) with a 5
seconds periodicity
The soware resource of the SBL10e device set at factory are not valid. It should never occur. For further
informaon, contact support@qeedji.tech.
Nominal
or
recovery
4 very short and consecuve
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 consecuve
blue flashs (150 ms) A SBL10e device configuration is in progress. Please wait a couple of seconds.

9
1.2.1 Web services
These are the supported Web services for the smart_office_obs applicaon to command and control the SBL10e:
GET POST PUT DELETE
api/v1/sys/power yes <state>=rebooting “” Reboot the device 1.10.11
api/v1/software/version yes None “1.10.10” Get the device delivery software version 1.10.11
api/v1/software/label yes None “bm0032_smart_office_obs” Get the device delivery software label 1.10.11
api/v1/sys/sn yes
PSN Short representation, example :
“01320-04800”
Get the device SN 1.10.11
api/v1/sys/model-name yes None SBL10e Get the device model name 1.10.11
api/v1/sys/manufacturer yes None Qeedji Get the manufacturer 1.10.11
api/v1/sys/manufacturer-url yes None www.qeedji.tech Get Web Site of manufacturer 1.10.11
api/v1/wpan1/mac yes None Bluetooth MAC address value user
formatted: “aa:bb:cc:dd:ee:ff” Get the device Bluetooth MAC address 1.10.11
api/v1/sys/manufacturer-url yes None www.qeedji.tech Get Web Site of manufacturer 1.10.11
api/v1/leds/light yes
Webservice path
HTTP method
Query string parameters Body Function
api/v1/sys/uuid yes
1.10.11
Uuid string value: <uuid> = <psn>-
<48x0>-<mac-48>
Example:
“05010024-0000-0000-0000-
001ce6021bf6”
<state>= off | steady | flashing
<color>=red | orange | blue | yellow | green
Get (plain text, separator CR):
state=<state>
color =<color>
From t he
smart_office_obs application
version
None Get the device UUID 1.10.11
Get busylight led color and state
Examples with CURL tool:
reboot the device:
curl --user "<USERNAME>:<PASSWORD>" -i -X PUT "http://<DEVICE_IP_ADDR>/api/v1/sys/power?state=rebooting"
get device state & color:
curl --user "<USERNAME>:<PASSWORD>" -X GET "http://<DEVICE_IP_ADDR>/api/v1/leds/light"
get device firmware version:
curl --user "<USERNAME>:<PASSWORD>" -X GET "http://<DEVICE_IP_ADDR>/api/v1/software/version"

10
2.1 Configuraon Web interface
The SBL10e device has a Web-based configuraon interface that can be accessed with a Web browser. The supported browsers are: Google Chrome , Mozilla Firefox , MS-Edge
and MS-Edge (Chromium) .
It is accessible from the URL:
http://<device_IP_addr>/
By default, the login credenals for the configuraon Web interface and the Web server are:
login: admin ,
password: admin .
In the smart_office_obs applicaon, this pane allows to watch:
the current light status,
the current light state.
Administraon console
Click on the Administration Console buon to access the device configuraon interface.
◬
Aer you have changed and saved all your sengs in the different panes, be sure to perform a device restart by clicking the Reboot the device buon so that your changes
are fully reflected.
Click on the device logo at the le top corner to return to the main page.

11
2.1.1 Configuraon > Administrator
In the Configuration pane, select the Administrator menu to change:
the hostname,
the login credenals.
For security reasons, it may be useful to change the login credenals for the device's configuraon Web interface. Please keep these login credenals in a safe place aerwards.
It is recommended that you enter a unique Hostname value for each device. In case several SBL10e devices are located in different buildings or geographical locaons, we
recommend that you enter hostname values with informaon about the building and the locaon (e.g. Hall-RD-Paris-1 ).

12
2.1.2 Configuraon > LAN
In the Configuration pane, select the LAN menu to set up the network configuraon of the LAN interface of your device:
☛ By default, the device is configured with DHCP acvated. In case the DHCP server is not available, aer the DHCP meout, the device ends up using the stac IP address whose
the default value is 192.168.0.2 when it has not been changed yet by the end user.

13
2.1.3 Configuraon > Servers
In the Configuration pane, select the Servers menu to define the configuraon of the servers peripheral to your device.
The Datasource Server is the server machine having the dynamic informaon of the current state and the current color to apply to your light:
Datasource Server :
Address : enter the IPv4 address, or the domain name of your Datasource Server ,
Port : enter the operang port of your Datasource Server ,
Heartbeat : periodicity of the connecon to the Datasource Server (default: 10 seconds).
HTTPS proxy :
Address : enter the IPv4 address, or the domain name of your proxy server,
Port : enter the operang port of your proxy server.
DNS servers .
This is an example of HTTP request, including the appropriate SBL10e PSN value, sent to the datasource server, to get the last light state and color values to apply to the SBL10e
device:
Method Path Host
GET /smart_office_obs-gatewayapi/v1/leds/light/01320-04800 HTTP/1.0 <datasource_server_address>
☛ With 01320-04800, an example of SBL10e device's PSN value.

14
2.1.4 Maintenance > Firmware
From the Maintenance pane, select the Firmware menu to view the version of the firmware installed on your device.
☛ Correcve and evoluve maintenance soware versions are regularly made available in the support tab of the official Qeedji website hp://www.qeedji.tech. It is
therefore advisable to regularly update your device. From this website, download the appropriate latest firmware version available for your device model ( .bin file). For
further informaon, contact [email protected]ech.
Drop your .bin file in the Drop file here or click to add one buon , then click on the Send buon to update the firmware version of your device. Wait a couple of seconds,
the me to load and install the new version. Go back to the configuraon Web interface and check the new firmware version number of the device.
The user preferences common to the both applicaons are kept when upgrading from smart_office_obs applicaon to another applicaon (and reciprocally) meaning:
network configuraon,
file system,
hostname,
credenals.
◬
Do not electrically disconnect the device during the firmware upgrade.

15
2.1.5 Maintenance > Preferences
In the Maintenance pane, select the Preferences menu to view all the preferences.
The filter allows you to list only those preferences whose name contains the string entered in the filter. All the preferences have opmal default values.
◬
Before changing any value of a preference, please consult your Qeedji support.
Double click on a preference to change its value.
The Restore factory preferences buon resets a subset of preferences allowing the device to reprogram its factory preferences. In this case the LAN network configuraon
returns to DHCP.

16
2.1.6 Maintenance > Tools
In the Maintenance pane, select the Tools menu to:
view the available space on the flash memory storage¹ (max 8 MiB),
format the flash memory storage¹,
add the Trusted certificate (.crt) of the Datasource server .
¹ The flash memory storage is used to store all the directories and files hosted at the root of the WebDAV directory, and the user preferences as well. In case a flash formang, the
SBL10e device returns to the default factory sengs. In this case, the trusted cerficate is erased.

17
2.1.7 Maintenance > Files
In the Maintenance pane, select the menu Files to see the files hosted at the root WebDAV directory.
The .conf folder is containing a prefs.json file which is corresponding to the configuraon programmed as soon as a modificaon is done through the configuraon Web
interface.
◬
The prefs.conf configuraon file can be different for smart_office_obs applicaon and other applicaons.

18
2.1.8 Informaon > Device
In the Information pane, select the menu Device to view system informaon about the device.
Firmware : label and version of the firmware embedded in the device,
Model : model of the Qeedji device,
Manufacturer : product manufacturer name,
Manufacturer URL : manufacturer Web site,
Hostname : name of the device on the network,
UUID : Universal Unique IDenfier,
PSN : Product Serial Number.

19
2.1.9 Informaon > Network
In the Information pane, select the Network menu to view a summary of the device's network configuraon.

20
2.2 Recovery by Qether
In case an applicaon can not be executed, the SBL10e returns to a Recovery mode, waing for new applicaon version update.
The provided Qether tool allows to make some remote operaons on the SLB10e, based on its device MAC address like:
SBL10e firmware upgrade,
SBL10e configuraon update,
SBL10e reboot.
The <product_type> is an extract of the device PSN value. For example, the 0132x-xxxx PSN value leads to the 0132 <product_type> .
The <SBL10e_device_MAC_address> is the MAC address of the device with the format 00:1C:E6:AB:CD:EF .
◬
The MAC address of the device is wrien on the label stuck at the back of the SBL10e device with the format 00-1C-E6-AB-CD-EF .
Discover command example
This command allow to find out the SBL10e devices present on the local network:
qether.exe FF 0132 discover
Configuraon command example
Send a configuraon file and apply it (default parameters):
qether.exe <SBL10e_device_MAC_address> <product_type> configure -f prefs.json
Example of prefs.json file for smart_office_obs applicaon:
{
"system.httpd.username":"admin",
"system.httpd.password":"admin",
"system.lan1.ipv4.addr":"192.168.0.2",
"system.lan1.ipv4.netmask":"255.255.255.0",
"system.lan1.ipv4.static-addr":false,
"system.hostname":"sbl10",
"system.lan1.ipv4.gateway":"192.168.0.6",
"system.lan1.dhcp.overall-timeout":30,
"system.lan1.dns.primary":"192.168.0.1",
"system.lan1.dns.secondary":"192.168.0.4",
"system.lan1.dns.static":false,
"system.lan1.upnp-gateway":false,
"appli.network.datasource.url.hostname":"192.168.2.17",
"appli.network.datasource.url.port":443,
"appli.network.datasource.heartbeat":10,
"appli.network.datasource.credential.type.value":"None",
"appli.network.proxy.https.enable":true,
"appli.network.proxy.https.url.hostname":"192.168.1.69",
"appli.network.proxy.https.url.port":3128,
"appli.network.proxy.https.credential.type.value":"None"
}
☛ The system.httpd.username preference value is limited to 15 characters max. The system.httpd.password preference value is limited to 100 characters max. The
alphanumeric characters and these {}|~[]!#_$&()/;<=@|^%?+~((),' are supported for the system.httpd.username and system.httpd.password preference values.
☛ The system.hostname preference value is limited to 15 characters max. The alphanumeric characters, the character - and the character . are supported for the
system.hostname preference value.
☛ To get an IP address with the DHCP server, set system.lan1.ipv4.static-addr with the value false . Else to work with a stac IP address, set system.lan1.ipv4.static-
addr with the value true .
Reboot command example
Reboot the target device:
qether.exe <SBL10e_device_MAC_address> <product_type> reboot
Firmware upgrade command example
Send a firmware file, with default transfer parameters, and install it. For example:
qether.exe <SBL10e_device_MAC_address> <product_type> install -f bm0032_smart_office_obs-sbl10e-setup-1.10.10.bin
☛ Qether needs first to be installed on your MS-Windows computer. For further informaon, refer to the Qether user manual.
Other manuals for SBL10e
3
Table of contents
Other Qeedji Lighting Equipment manuals