Qeedji SAP10e User manual
User manual
SAP10e generic server
1.11.10 001B
2
Legal notice
SAP10e generic server 1.11.10 (001B_en)
© 2022 Qeedji
Rights and Responsibilities
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.
WEEE 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.1.5
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
3.1.13
3.1.14
4.1
4.2
5.1
6.1
6.2
6.3
6.4
Table of contents
Part I : Description and installation
Introduction
Getting started with the device
Device dimensions
Labelling
Installation
Uninstallation
Applications
Part II : Applicative user interface
Applicative user interface
Part III : Administration console user interface
device configuration Web user interface
Configuration > Administrator
Configuration > LAN
Configuration > Servers
Configuration > SLATEs pairing
Configuration > Date and time
Configuration > Tasks
Maintenance > Firmware
Maintenance > Preferences
Maintenance > Logs
Maintenance > Tools
Maintenance > Files
Information > Device
Information > Network
Information > WPAN peripherals
Part IV : Technical information
Technical specifications
Conformities
Part V : Contacts
Contacts
Part VI : Appendix
Appendix: Qeedji PowerPoint publisher for SLATE
Appendix: Qether
Appendix: Web services
Appendix: Device configuration with TFTP server (+ DHCP server code 66)
4
Part I Description and installation
5
1.1 Introduction
This manual explains how to install and configure your SAP10e device.
The SAP10e device allows up to ten SAP10e e-papers to be connected to a TCP/IP network.
Once the generic_server application is installed, the access point can connect itself and periodically to file remote server to get the PPK contents.
Recommendations and warnings
This device is designed for indoor use only.
Package Contents
Articles Description
Device SAP10e device with the default regular ¹ application embedded.
¹ It is possible to easily update the device with the generic_server application afterwards.
☛ In this documentation, the unit of measurement for dimensions is done in millimeters followed by its equivalent value in inches.
7
1.1.2 Device dimensions
8
1.1.3 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 QR code on the product label is corresponding to the product identification URL, for example:
i.qeedji.tech?model=SAP10e&sn=01390-00001&mac.lan1=00-1C-E6-02-4C-EC&mac.wpan1=F3-5C-2A-3F-F5-4B .
Packingbox 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 Website.
☛ The QR code on the packingbox label is corresponding to the product PSN, for example:
PSN01390-00001 CD6 .
☛ The serial number of the device could be requested in case of technical support.
9
1.1.4 Installation
☛ Install the SAP10e device on the Ethernet wall plugs of the buildings following the installation map given by your IT departement.
The SAP10e device has to be plugged to an Ethernet wall plug supporting PoE IEEE802.3af.
Given 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 Ethernet connector, the SAP10e device can be installed on vertical surfaces, like walls as well as horizontal
surfaces, like ceilings.
11
1.2 Applications
Once the generic_server firmware is installed on the device, the generic_server application allows to:
visualize the content of the ten SLATEs and check whether each SLATE content is synchronized with the content sources, hosted in the
.output/<1>/ to .output/<10>/ WebDAV directories of the SAP10e device.
once the URL of the remote file server is properly set in the SAP10e device, the content sources are updated automatically by the generic_server
application which is connecting periodically to a remote file server which is containing all the required contents for all the SLATEs.
Configuration
The application for SAP10e device supports configuration update:
by connecting to the device configuration Web user interface,
by uploading, with a WebDAV client, a suitable .js configuration script (or a suitable prefs.json file) on the http://<device-ip-addr>/.conf/
WebDAV directory of the SAP10e device,
by receiving a configure command from the Qether tool (Qether V1.12.10 or above).
Generic server application upgrade
The regular application is put by default on the SAP10e device at the factory.
The first step is to upgrade the device with the generic_server application.
The application can be upgraded:
by using the device configuration Web user interface,
by pushing, with a WebDAV client, a new firmware file bm0032_generic_server_generic_server-sap10e-xx.yy.zz.bin at the root of the device
WebDAV directory http://<device-ip-addr>/ ,
by receiving an install command from the Qether tool (Qether V1.12.10 or above).
☛ After a firmware upgrade, the device is rebooting once.
SLATE software upgrade
It is possible to upgrade the software version of the SLATEs paired to the SAP10e devices:
by pushing, with a WebDAV client, a pictureframe-slate106-setup-xx.yy.zz.rpk firmware file suitable for the SLATE devices, on the
http://<device-ip-addr>/.output/common/ WebDAV directory of the SAP10e device,
by using the device configuration Web user interface.
Preprogrammed flashing sequence
The SAP10e device has two modes:
Nominal mode : the application runs properly. When a configuration or a firmware upgrade is in progress, the light illumination follows the light
flashing sequence below.
Recovery mode : the application can not be executed. It is required to upgrade the firmware to return to nominal mode.
Depending on these modes, the applications can fall into one of these preprogrammed flashing sequences in some specific cases.
Mode Status green LED behaviour Information
Nominal 1 green flashs (2 seconds)
with a 4 seconds periodicity The application is running properly.
Recovery
2 very short and
consecutive green flashs
(250 ms) with a 4,5 seconds
periodicity
The application can not be executed. It should never happen. The device Web user interface is
so not available. This sequence is displayed until a new firmware upgrade is done with Qether
Recovery
3 very short and
consecutive green flashs
(250 ms) with a 5 seconds
periodicity
The software resource of the SAP10e device set at factory are not valid. It should never happen.
Nominal
or
recovery
4 very short and
consecutive green flashs
(250 ms) with a 5,5 seconds
periodicity
A Firmware upgrade for the SAP10e device is in progress. Please wait a few seconds.
Nominal 5 very short and
consecutive green flashs
(250 ms) A device configuration for the SAP10e device is in progress. Please wait a few seconds.
Mode Red LED behaviour Information
Nominal or recovery On (steady) The SAP10e device is powered properly.
Nominal or recovery Off The SAP10e device is not powered properly.
12
Part II Applicative user interface
13
2.1 Applicative user interface
The SAP10e device supports a Web user interface that can be accessed with a Web browser. The supported Web browsers are: Google Chrome , Mozilla
Firefox , MS-Edge (Chromium) .
It is available from the URL: http://<device_IP_addr>/ .
The URL falls automatically into the regular applicative user interface: http://<device_IP_addr>/webui/ . This pane allows to:
view the 10 SLATE contents (from index 1 to index 10) and check whether each SLATE content is synchronized with the SAP10e device content
sources,
display a synchronization state for each SLATE index with the following background color:
grey: default color when no SLATE is paired for this index,
green: the SLATE content is properly synchronized,
orange: the SLATE content synchronization state is not yet determined,
red: the SLATE content is not properly synchronized.
☛ To refresh the synchronization state, click on the Refresh button.
☛ To be synchronized, the SLATEs needs first to be paired with the right index. To check simply whether some SLATEs are paired to the SAP10e
device, refer to the chapter § Information > WPAN peripherals. Then, a suitable hub.ppk content must be present in the respective
/.output/<index>/ WebDAV directories. For further information, refer to the chapter § Maintenance > Files.
☛ When no SLATE are paired at all, all the containers from /.output/1/ to /.output/10/ are empty and the respective synchronization state
have a grey background color.
Example with 4 SLATEs paired on the index 1, 2, 3 and 5:
14
Part III Administration console user interface
15
3.1 device configuration Web user interface
The SAP10e device supports a Web user interface that can be accessed with a Web browser. The supported Web browsers are: Google Chrome , Mozilla
Firefox and MS-Edge (Chromium) .
It is available from the URL: http://<device_IP_addr>/ .
The default credentials values, put at factory, to access to the device Web user interface are:
login: admin ,
password: admin .
The URL falls automatically into the applicative user interface¹. At the top right corner, click on the Administration Console button.
¹ For further information, refer to the chapter § Applicative user interface.
This is the device configuration Web 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
16
3.1.1 Configuration > Administrator
In the Configuration tab, select the Administrator menu to change:
the Hostname ,
the login credentials:
Administrator name ,
Password .
☛ It is recommended that you enter one unique Hostname value for each device. In case several SAP10e 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-RD-Paris-1 ).
For security reasons, it may be useful to change the login credentials values. Please keep them in a safe place afterwards.
☛ The same login credentials are used to access to the WebDAV server and use Web services.
17
3.1.2 Configuration > LAN
In the Configuration tab, select the LAN 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 automatically in the local network environment of your computer.
Enter a suitable LAN network configuration to that the device can access to the Web to get the local time with a NTP server.
☛ By default, the device is configured with Obtain an IP address automatically by DHCP activated and Time for attempts inactivated. As soon
as the DHCP server becomes available, the device ends by getting back a valid IP address given by the DHCP server within less than one minute.
☛ After a device reboot, when the device is configured with Obtain an IP address automatically by DHCP activated and Time for attempts is
activated, in case the DHCP server is unavailable after the Time for attempts duration (10 minutes, maximum and default value) has expired, the
device ends up using the static IP address entered in the LAN configuration. The default static IP address is 192.168.0.2 when it has never been
changed yet by the user. It is recommended to set an appropriate IP address, netmask and gateway if this case would happen. In case a daily
reboot task is programmed, the device will restart this operation every days.
☛ When only the Time for attempts value is modified, press on TAB key of your keyboard to make appear the Validate button.
18
3.1.3 Configuration > Servers
In the Configuration tab, select the Servers menu to define the configuration of the servers peripheral to your device.
The Datasource Server is the server machine having the dynamic information of the PPK content to get from the id 1 to 10 so that it can be then
transmitted to the SLATEs paired to the SAP10e device:
Datasource Server :
URL : enter the URL² including the port of your Datasource Server (only the http scheme is supported) ,
Credential
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,
Heartbeat : periodicity of the connection to the Datasource Server , from 100 seconds (default value) to 900 seconds (15 minutes).
DNS servers : enter the IPV4 address of your favorite DNS,
NTP time server .
☛ The NTP time server is the only way for the SAP10e device to be on time. Once the device is on time, the date and time is transmitted to the
SLATEs. When the NTP time server is configured, ensure to have a valid gateway and a valid DNS 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. http://user1:[email protected]:8081/webdir/01320-00550 .
☛ When only the Heartbeat value is modified, press on TAB key of your keyboard to make appear the Validate button.
² The URL has to match the directory of your database. If you have more than one SAP10e device to control, it is advised to implement one directory per
SAP10e device with the directory name matching either the device PSN, or the device MAC address, i.e.: http://192.168.10.10:8081/webdir/01320-00550
with 01320-00550, an example of PSN value from a SAP10e device, or http://192.168.10.10:8081/webdir/00-1c-e6-02-4c-ad with 00-1c-e6-02-4c-ad, an
example of MAC address value from a SAP10e device.
To put the same URL for all your SAP10e device datasource inputs, you can use two kind of variable values intrinsic to the device:
Variable type String to set in the input Value example
deviceInfo:mac variable {$deviceInfo:mac} 00-1c-e6-02-4c-ad³
deviceInfo:psn variable {$deviceInfo:psn} 01390-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 URL would be for example:
http://192.168.10.10:8180/webdir/{$deviceInfo:mac} or,
http://192.168.10.10:8180/webdir/{$deviceInfo: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.
◬
Servers available with the https scheme are not supported.
◬
Upgrading the SAP10e device with another application type will clear the current datasource configuration data. When the SAP10e device is
properly configured, it is advised to build and save an appropriate SAP10e device configuration script ( .js ) by using the configuration script
template or save at least the prefs.json configuration file of your SAP10e device. For further information, refer to the chapter § Maintenance >
Files.
19
3.1.4 Configuration > SLATEs pairing
In the Configuration tab, select the SLATEs pairing menu to pair the SLATEs to your SAP10e device.
The SAP10e device is designed to work with at least one and up to ten SLATEs.
◬
In case you are using a SAP10e device already installed, it is recommended to double check its wake-up configuration before starting any
configuration (ex: appli.pictureframe.slate.*.wakeup.day.interval and appli.pictureframe.slate.*.wakeup.weekdays.mask preferences). For further
information, refer to the chapter § Maintenance > Preferences. In the factory configuration, the SAP10e device configures the SLATEs so that they wake-
up every 15 minutes from 8:00 AM to 7:00 PM.
Prepare SLATE pairing configuration
◬
Before starting any SLATE pairing, ensure that your device is on time. For further information, refer to the chapter § Maintenance > Preferences.
To pair properly one or several SLATEs to your SAP10e device, you need to define for each SLATE PSN (Product Serial Number):
a specific Index : between 1 and 10,
a specific Hostname : max: 8 alphanumeric digits.
In case you have to use several SAP10e devices, prepare the same information for all of them.
For example, when the SLATEs are installed in different locations and in different buildings:
Building A:
SAP10e device's hostname Location SLATE PSN slate # slate hostname slate pairing PIN Code
floor-1 Pr. Maddie NELSON office 00903-00050 1 1-1 none
floor-1 Dr. John SMITH office 00903-00051 2 1-2 none
floor-1 Dr. Patricia DUCHON office 00904-00052 3 1-3 none
floor-1 Waiting room 00904-00053 5 1-5 none
floor-1 Sonia DELACOURT office 00904-00053 6 1-6 none
Building B:
SAP10e device's hostname Meeting room name SLATE PSN slate # slate hostname slate pairing PIN Code
floor-2 Dr. Ashley ISAAC office 00900-00054 1 2-1 1234
floor-2 Dr. Xavier NELSON office 00900-00055 2 2-2 1234
floor-2 Pr. Stefan SCHMIDT office 00900-00056 3 2-3 1234
☛ When a pairing PIN code is required, it is the same one for all the SLATEs to pair.
20
SLATEs configuration
As soon as a SLATE is paired to a SAP10e device, it inherits of the configuration file APPLI.CFG provided by the SAP10e device.
Wake-up policy:
wake up regularly: every quarter of an hour,
active days: 5/7 days,
active interval: 8.00 AM - 7.00 PM.
So before starting any pairing procedure, check attentively the SAP10e device configuration for the SLATE.
For further information, refer to the chapter § Maintenance > Preferences.
Pairing procedure
The SAP10e device pairing allows to associate one or several SLATEs to a SAP10e device. A SLATE can be paired to only one SAP10e device at a time.
◬
When a new SAP10e device is trying to pair a legacy SLATE already paired to another SAP10e device, the SLATE will be paired to the new
SAP10e device and unpaired automatically from the other device. To prevent from any unexpected SLATE pairing by another user, a pairing PIN
code can be used.
☛ The pairing PIN code is not activated by default.
◬
The SAP10e device can detect the SLATEs after they have woken up at least one since the device booting-up. In the default factory
configuration, the SLATEs are programmed to wake-up and communicate for a while on the WPAN network every 15 minutes then fall again into
Sleep mode.
a) List the available SLATEs on the WPAN network
Connect to the SAP10e device Web user interface, and in the Configuration > SLATEs Pairing menu, click on the Activate button.
☛ When there is no user action change in the SAP10e device configuration during one minute, the pairing is aborted automatically. To launch
again the pairing procedure, click again on the Activate button.
Wait for 15 minutes until all your SLATEs are detected by the SAP10e device. They should appear with their PSN in the SLATEs detected left table.
Other manuals for SAP10e
1
Table of contents
