ArtFrame Kit - Manual

ArtFrame

Table of Contents

ArtFrame Kit - ManualTable of ContentsTechical SpecificationComponentsAssemblyInitial StartupConfigurationUser InterfaceModeLocalRemoteFilesSettingsWiFiPasswordImage Server URLRefresh IntervalSave & RestartSet up your own image serverImage Format (.rawz)Battery ChargingTroubleshootingError MessagesUnexpected BehaviorFirmware UpdateDriver InstallationWindowsMacLinuxFlashing the FirmwareReset to Factory SettingsResetNotes

Techical Specification

Frame

Display

Battery & Power

Storage

Configuration

Size and Weight

Components

To assemble your ArtFrame you will need the following components:

ComponentImage
Display with driver board on the backBauteil Display
FrameBauteil Rahmen
Rear shellBauteil Rückwandschale
Rear panelBauteil Rückwandplatte
Momentary switch with status LEDBauteil LED-Taster
MainboardBauteil Mikrocontroller
Voltage transformerBauteil Spannungswandler
2x Screws (M3, Hex 2 o. TR8), 2x nuts (M3), 2x spacer (M3)Bauteil Schrauben
Wire harnessBauteil Kabelbaum
BatteryBauteil Akku
USB to Micro USB cableBauteil Ladekabel

Assembly

⚠ Caution
Never use force when assembling the device. All components can be connected and disconnected without using force. To disconnect a connection, do not pull directly on the cables. Instead, gently wiggle the connector until it releases from the socket.
⚠ Caution
Be especially careful when handling the display flex cable to avoid damaging it. The flex cable is very fragile and can easily tear, especially when subjected to shear or tensile forces.
⚠ Caution
Make sure that the device is de-energized before disconnecting or connecting any cables. The device must not be connected to a micro USB cable or the battery during this time.

The assembly of your ArtFrame is done in ten easy steps:

Assemby stepImage
Put the rear panel into the rear shell.Montageschritt 1
Mount the mainboard with the screws, nuts and spacers to the back plate. The screw heads need to face towards the outside, the nuts face the inside of the back plate. The spacers go between Mainboard and back plate.Montageschritt 2
Connect the wire harness. The visible metal contacts of the connectors always face upwards. ⚠ Attach the connectors by applying gentle counter pressure on the pins. Never apply pressure on the mainboard.Montageschritt 3
Insert the voltage transformer into the cable harness and glue it into the rear panel. The purple cable must be connected to the SHDN output of the voltage transformer.Montageschritt 4
Glue the battery in place, but without connecting it. Then guide the connection cable through the opening in the rear panel. ⚠ Do not connect the battery until the display is connected.Montageschritt 5
Screw the LED momentary switch into the frame.Montageschritt 6
The LED button has four contacts. The orange cable must be connected to the contact with the + symbol, the yellow cable to the left or right of it. The connected green and blue cable is connected to the two remaining contacts in arbitrary order.Montageschritt 7
Connect the display driver board to the cable harness (white connector). ⚠ Make sure that there is no tension on the wires at any time.Montageschritt 8
Insert the glass into the rear panel with the matte side facing up. Make sure that there are no dirt particles between the display and the glass. Then slide the frame over the back panel so that the LED button is threaded into the recess and push it in gently. ⚠ Do not try to force the LED button in, otherwise the display's ribbon cable could be damaged. Montageschritt 9
Connect the battery to the motherboard.Montageschritt 11

To open the device, simply follow the steps backwards.

Initial Startup

As soon as the assembly is completed, your device can be put into operation. The device's battery is already pre-charged upon delivery. However, to ensure maximum runtime, the battery should be recharged via the micro USB port on the motherboard, which can be accessed via the back of the device. A full charge can take up to 5 hours.

ⓘ Important Note
The device does not have a battery charge indicator. When the battery is low, the images are only built up incompletely. You should charge the battery at the latest then.

Some images are already pre-installed at delivery. The time between automatic image changes is configurable and factory set to one hour. Most of the time your ArtFrame will spend in sleep mode to save the battery. Then the status LED is off. If it is on, the device is active.

If you now press the LED button briefly, the status LED will start to light up. After a few seconds, the image will change, after which the status LED will go out.

If, on the other hand, you press the LED button for longer than four seconds, the configuration mode starts instead, which is explained in the following chapter. If you now press the LED button a second time, the configuration mode is ended and a new image is displayed. The device now switches to the idle state and the status LED goes out.

Configuration

To adjust the settings of your device, press and hold the LED button on the bottom of the device for approx. 4 seconds. The status LED immediately starts to light up and the words CONFIGURATION MODE appear on the display. Follow the instructions on the display.

Configuration Mode

If you are doing the configuration for the first time, a WiFi hotspot with the name ArtFrame will now be created. Connect your smartphone or laptop to this WiFi and then open the URL http://192.168.1.1 in the web browser.

ⓘ Important note
On some Android devices, opening the URL only works when the mobile data connection is turned off.

If you have already stored WiFi and Password in the settings, the device will first try to log into that WiFi and provide the configuration interface there. This way you can configure the device via your home network. The URL to be opened in the browser is different then. However, if the connection attempt fails, the WiFi hotspot described at the beginning is created instead.

ⓘ Important Note
The device has an increased power requirement during configuration mode. To achieve the maximum runtime, you can charge the device via the micro USB port on the back after configuration.

User Interface

The behavior of your ArtFrame can be customized via the configuration interface. In addition, the version of the currently installed software is displayed in the lower right corner. The various settings are explained below.

Conf - Mode - Local

Mode

This switch can be used to select between Local and Remote mode. Depending on the selection, various specific settings are visible.

Local

In Local mode, the ArtFrame will display images from the local memory of the device.

Remote

In Remote mode, the images are loaded and displayed via the WiFi.

ⓘ Important note
In Remote mode, image switching takes a bit more time than in Local mode. Thus, the battery life is slightly reduced in this mode.

Files

These settings are only relevant for the Local mode. Here you can manage the images stored on your ArtFrame. A status bar indicates the used storage space. Below there is a list of the images stored on your ArtFrame. An image can be deleted using the Trash icon. Using the Upload Files ... button, images can be selected and transferred to the ArtFrame. For each selected image a preview is displayed where contrast and brightness can be adjusted. A dashed line indicates the image section to be transferred. It can be moved and resized.

Conf - Prepare

The adjustments are confirmed with the OK button. The image is now processed and transferred.

Settings

General settings can be changed here. Some of them are only relevant in Remote mode.

WiFi

If your ArtFrame is to be operated in Remote mode, the WiFi via which the connection is to be established can be entered here. The WiFi must transmit via the 2.4 GHz band. 5 GHz is not supported.

ⓘ Note
If this setting is not empty, your ArtFrame will first try to dial into the stored WiFi when starting the configuration mode. This way you can directly access the configuration interface within this WiFi. If the connection fails, a separate WiFi hotspot with the name ArtFrame will be started instead.
Password

If the WiFi to which your ArtFrame is to connect is password protected, the password must be entered here so that the connection can be established.

Image Server URL

If your ArtFrame is to be operated in Remote mode, the URL from which the images are to be obtained can be entered here. For testing the URL http://framelabs.eu:8090/ is preset.

ⓘ Note
The URL must consist of protocol, domain name, optional port, and a path. The path must not be empty. Therefore, in the example above, the / at the end must not be omitted.

How to start up a self-hosted Image Server is described in the following chapter.

Refresh Interval

This setting determines how much time should elapse between image changes. The time interval can be set to the minute. We recommend an interval of one hour.

ⓘ Note
The longer the interval, the longer the battery will last until it needs to be recharged.

Save & Restart

When you press this button, the settings are saved. The device exits the configuration mode, performs a picture change and enters sleep mode.

Conf - Finished

Set up your own image server

Your ArtFrame has the ability to download and display images over WiFi. The images must be converted to a format readable by your ArtFrame using the Converter. You then place the resulting files with the extension .rawz in a folder.

The image server software imageserver.py is a Python program that can provide the .rawz files within a folder via an HTTP interface. For each request a random image is selected.

To display the images on your ArtFrame, it must be set to Remote mode, WiFi and Password must be entered correctly and the Image Server URL must be set to http://[IP address of server]:8090/.

Image Format (.rawz)

The .rawz image format is a zlib-compressed framebuffer with 4 bit per pixel, starting line by line from the top left. Every byte contains two pixels, with the left pixel as the more significant bits. A sample implementation showcasing the conversion from and to the format can be found at https://github.com/framelabs-eu/tools.

Battery Charging

Connect the micro USB port on the back of the device to a USB charger using the USB to micro USB cable. A full charge can take up to five hours. There is no externally visible charging indicator.

Troubleshooting

If problems occur during operation, you can search for possible solutions here.

ⓘ Note
The e-paper display retains its content even without power. In the event of an error, always check whether the status LED is lit first. Only then are any instructions on the display also up-to-date.

Error Messages

Error messages that appear on the display or the configuration interface are usually external errors.

Error MessageSolution
Could not connect to WiFiThe device is running in Remote mode but cannot connect to the configured WiFi. Check the saved WiFi and Password and make sure that the WiFi is reachable on the 2.4 GHz band. If this does not remedy the situation, reduce the distance to the WiFi router.
Couldn't connect to serverThe device is running in Remote mode but cannot receive data. Check the saved Image Server URL.
No pictures installedThe device is running in Local mode, but there are no images installed. First load images onto the device.
Error: Not enough spaceThe local storage of your ArtFrame is full. If you want to transfer more images to the device, you must first delete other images from its local storage.

Unexpected Behavior

If unexpected behavior occurs during operation, but no error message appears, it is often an error that is caused by the battery level being too low. The following error pattern is typical for this: The new image could no longer be built up completely. In such a case, the battery should definitely be fully recharged.

Drained Battery

Further problems and possible solutions are listed below.

Problem DescriptionSolution
The configuration interface cannot be reached.Check whether the status LED is lit. If this is not the case, the battery must be charged.
 Check if your smartphone or laptop is connected to the WiFi that is mentioned on the display.
 If you are using an Android smartphone, disconnect the mobile data connection and then try again.
 Try to establish a connection with another device.
 Check whether the ArtFrame reacts when you press the LED button briefly.
An image cannot be uploaded.With very large images in connection with old smartphones, the phone can be overwhelmed when processing. Try again with a different browser, smaller image or with a smartphone with more RAM.
Images show artifacts, look incomplete, or are not fully displayed.Charge the battery.
The status LED does not light up after the LED button has been pressed.Charge the battery.
The status LED flashes once when you press the LED button and then goes out.There is an error with the communication to the display driver board. Charge the battery. If this does not solve the problem, check the cabling.
The status LED flashes twice when you press the LED button and then goes out.There is an error with the initialization of the display driver board. Charge the battery. If this does not solve the problem, check the cabling.
The status LED flashes three times when you press the LED button and then goes out.There is an error with the initialization of the display driver board. Charge the battery. If this does not solve the problem, check the cabling.
The status LED does not light up when you press the LED button.Charge the battery. If this does not solve the problem, check the cabling.
The device no longer responds, but the status LED is lit.Perform a reset.

Firmware Update

New firmware versions can be found in the support area at https://framelabs.eu/support. Download the latest version for your ArtFrame and unzip the file archive. Connect your ArtFrame to your computer using the USB to Micro USB cable.

Driver Installation

To update the firmware you need the driver for the serial-to-USB converter CH340 and the esptool.py.

Windows

CH340 driver: https://cdn.sparkfun.com/assets/learn_tutorials/8/4/4/CH341SER.EXE

esptool.py: https://github.com/espressif/esptool

Mac
Linux

The CH340 driver is pre-installed in most distributions.

Flashing the Firmware

The port is COM1 for Windows, /dev/ttyUSB0 for Linux and /dev/tty.wchusbserial1410 for Mac. The numbers at the end may vary from system to system.

Reset to Factory Settings

To reset your ArtFrame to the factory settings, all settings must be deleted. The picture storage remains unaffected.

Reset

If an error occurs where the Status LED is permanently lit and your ArtFrame cannot be turned off, you can restart the software.

ⓘ Note
Alternatively, a reset can be performed by pressing the reset switch located on the main board. However, it can only be reached through the opening in the rear panel when the rear panel shell is pulled out of the frame by a few millimeters.

Notes

Use a damp cloth to clean the device. Make sure that no moisture gets inside the device or onto electrical components.

Do not expose the device to temperatures below -10°C or above 40°C.

Do not operate the device in humidity above 90%.

Do not subject the device to hard impacts.