Download
Share
Print this page
  1. Manuals
  2. Brands
  3. Visual Productions Manuals
  4. Controller
  5. KIOSC
  6. Manual

Visual Productions Kiosc Manual

Hide thumbs Also See for Kiosc:

Advertisement

Quick Links

Download this manual
KI OSC
MAN UA L
©
V I S U A L P R O D U C T I O N S B V
W W W . V I S U A L P R O D U C T I O N S . N L

Advertisement

loading
Need help?

Need help?

Do you have a question about the Kiosc and is the answer not in the manual?

Questions and answers

Related Manuals for Visual Productions Kiosc

Summary of Contents for Visual Productions Kiosc

  • Page 1 KI OSC MAN UA L © V I S U A L P R O D U C T I O N S B V W W W . V I S U A L P R O D U C T I O N S . N L...
  • Page 2 Revision History Revision Date Author(s) Description 07.06.2018 Initial version. 14.06.2019 Added Kiosc Touch chapter, added info on elements, expanded the index section 01.02.2021 Added Elements appendix 08.01.2023 Added TCP function and details about feedback possibilities 23.06.2023 1.16.13 new features update 04.07.2023...
  • Page 3 Contents 1 Introduction 2 Kiosc App 3 Kiosc Touch 4 Kiosc Editor 5 File Locations Appendices A Elements B API...
  • Page 4 ©2024 Visual Productions BV. All rights reserved. No parts of this work may be reproduced in any form or by any means - graphic, electronic, or mechanical, including photocopying, recording, taping, or infor- mation storage and retrieval systems - without the written permission of the publisher.
  • Page 5 Declaration of Conformity We, manufacturer Visual Productions BV, herby declare under sole responsibility, that the following device: Kiosc Touch Conforms to the following EC Directives, including all amendments: EMC Directive 2014/30/EU And the following harmonized standards have been applied: NEN-EN-IEC 61000-6-1:2019 The object of the declaration is in conformity with the relevant Union harmonisation Legislation.
  • Page 7 Chapter 1 Introduction Thank you for choosing Kiosc. Kiosc (see figure 1.1) is a simple app for creating custom user-interfaces. These user-interfaces are typically used for controlling lighting and AV equipment. Kiosc communicates with the external equipment via OSC, UDP and TCP; protocols that run over the Ethernet network.
  • Page 8 Kiosc Editor. Finally, chapter 5 discusses the locations where the apps save and load the files on disk. At the time of writing this manual the Kiosc Touch, App and Editor are at version 1.17.21.
  • Page 9 • Multiple pages • Available on 5 operating systems • OSC, UDP and TCP • PIN lock Compatibility Kiosc is compatible with the following devices. • Visual Productions DaliCore • Visual Productions CueCore3 • Visual Productions CueCore2 • Visual Productions CueCore1 •...
  • Page 10 Chapter 2 Kiosc App The Kiosc app will present the customised dashboard to the user, typically running on a touch screen device. The Kiosc app itself has no editing capability in order to prevent the user from making accidental changes. Modes...
  • Page 11 It is using a propriety protocol that is only supported by the Visual Productions range of devices. This protocol is uni-directional and thus provides no means for giving feedback to the Kiosc app. No OSC or UDP is used in this mode.
  • Page 12 Figure 2.2 shows how to select the IoCore2 in the remote options. Once con- nected, the dashboard is created by adding a ’Kiosc’ actionlist inside the Io- Core’s show control page. Buttons, sliders and other controls can be added to this actionlist.
  • Page 13 In File mode it is possible to control multiple external devices on the network. By using OSC, UDP or TCP these devices can also send data back to the Kiosc app, providing it with feedback that could update the status of GUI controls.
  • Page 14 2.2.2 User Datagram Protocol (UDP) is a simple protocol for sending messages across the network. It is supported by various media devices like video projectors and Show Controllers. It does not incorporate error checking, making it an easy and fast protocol. 2.2.3 Transmission Control Protocol (TCP) is a secured protocol for sending messages across the network.
  • Page 15 TCP compared to OSC and UDP where you can easily broadcast messages. Options The options screen presents a few settings for customising the Kiosc behaviour. 2.3.1 Modes The modes selector allows you to choose between Remote and File mode. Modes...
  • Page 16 This menu (see figure 2.4) is only enabled when in Remote mode. It allows you to select the remote server. E.g. a CueCore or Kiosc Editor. Please note that due to Microsoft Store security measurements, it is not possible to to make a remote connection to Kiosc Editor if Kiosc and Kiosc Editor are running on the same PC.
  • Page 17 2.3.3 File This menu is only enabled when in File mode. It presents a list of the layout files. It also has buttons for saving, deleting and renaming files. The files can be locked and unlocked by long pressing them. When locked, they can not be modified.
  • Page 18 2.3.4 Grid Size In Remote mode (except when connected to Kiosc Editor )the size of the buttons and other controls are determined by the Grid Size setting. A smaller Grid Size results in larger controls. A larger Grid Size will allow more controls to fit on one page.
  • Page 19 IP address and PORT is a number between 1 and 65535. Figure 2.7: OSC options The incoming port field specifies the port number on which Kiosc will receive OSC messages. External equipment that will send feedback information to Kiosc needs to know this incoming port number.
  • Page 20 XXXs denote the IP address and PORT is a number between 1 and 65535. Figure 2.8: UDP options The incoming port field specifies the port number on which Kiosc will receive UDP messages. External equipment that will send feedback information to Kiosc needs to know this incoming port number.
  • Page 21 IP address and PORT is a number between 1 and 65535. Figure 2.9: TCP options The incoming port field specifies the port number on which Kiosc will receive TCP messages. External equipment that will send feedback information to Kiosc needs to know this incoming port number.
  • Page 22 2.3.8 Settings Language You can easily change the language used by the Kiosc choosing one of the languages available in the list. See figure 2.10. Figure 2.10: Changing settings Although the Kiosc app has no editing capabilities (all editing is done in the Kiosc Editor), it does have several settings that, if erroneously changed, can stop the system from working.
  • Page 23 Set the screen’s brightness of the Kiosc Touch. See figure 2.10. Sleep Set the time before the Kiosc Touch’s screen goes into sleep mode. In sleep mode, the screen turns dark to avoid useless brightness and save energy. Just touch once the screen to wake up the Kiosc Touch. 2.10.
  • Page 24 Read more about feedback loops in paragraph B.3.1. See figure 2.10. Time Format Set the format in which Kiosc Touch is going to represent time. There are two options between 24h or AM/PM. Date Format Set the format in which Kiosc Touch is going to represent date.
  • Page 25 Kiosc App On the Kiosc App the IP page shows a list of local IP addresses used by the device, as shown in figure 2.12. This information can be useful when trouble shooting network issues. The network settings are handled by the Operating System of the device running the Kiosc App.
  • Page 26 Kiosc Touch The IP page on the Kiosc Touch is used for setting the desired network settings, see figure 2.14. A static IP can be set, or the DHCP option can be checked for automatic configuration. Figure 2.13: IP page on the Kiosc Touch...
  • Page 27 Figure 2.15: KIOSC app About screen The About page of Kiosc Touch shows some complementary information about your device compare to the Kiosc app version. You will be able to find: • Serial number • PCB version •...
  • Page 28 • iOS Kiosc can be downloaded from the Apple iOS app-store at: https://itunes.apple.com/us/app/kiosc/id1131605366 • Android Kiosc can be found on the Google Play store at https://play.google.com/store/apps/details?id=nl.visualproductions.kiosc...
  • Page 29 • Ubuntu You can acquire the Kiosc app from the snap store: https://snapcraft.io/kiosc Alternatively, it can be installed by using the command-line: snap find kiosc snap install kiosc To update the apps later on via the command-line type: snap refresh kiosc Ubuntu 22.04 LTS is recommended.
  • Page 30 Chapter 3 Kiosc Touch The Kiosc Touch is a Touch screen solution created by Visual Productions. It is a standalone PoE-powered device running the Kiosc app. Figure 3.1: Kiosc Touch Compliance This device is in compliance with CE, UKCA and FCC regulations.
  • Page 31 Figure 3.2: Kiosc Touch mounting bracket The Kiosc Touch is wall-mount, it is compatible with European and American gang boxes. If no gang box is available then the Kiosc Touch can also be surface mounted. The mounting bracket of the Kiosc Touch suggests where you can create a hole for the cable to enter.
  • Page 32 Network The Kiosc Touch is a network device. A network connection between a com- puter running Kiosc Editor and the unit is required to program the Kiosc Touch. More information on this can be found in chapter 4. There are multiple possible arrangements for connecting the computer and the Kiosc Touch.
  • Page 33 The Kiosc Touch supports both static IP addresses and automatic IP addresses. By default, the Kiosc Touch is set to DHCP in which it will automatically be assigned an IP address by the DHCP server in the network. The ’DHCP server’...
  • Page 34 Figure 3.5: IP Settings The IP address or DHCP mode of the Kiosc Touch can be set in the ’IP’ tab in the settings menu, as shown in figure 3.5. The ’IP Address’ field is also where the current IP is shown.
  • Page 35 3.7.1 Home All the unit’s specific information. Figure 3.6: Web Interface home page 3.7.2 Monitor Displays all the incoming and outgoing messages. Figure 3.7: Web Interface monitor page...
  • Page 36 Figure 3.8: Web Interface about page Cloud Interface The Kiosc Touch can be linked with a Purple Cloud account. From there, the same information displayed in a local web interface can be remotely accessed. To link the unit, copy the Cloud ID found on the Account section and paste it into Settings page.
  • Page 37 Figure 3.9: Cloud ID...
  • Page 38 Chapter 4 Kiosc Editor The Kiosc editor is a software tool for designing Kiosc layouts. Installation The Editor is available on Microsoft Windows, Apple macOS and Ubuntu Linux. The software is distributed through app-stores; there are no stand-alone installa- tion packages (e.g. EXE, APK, DMG or DEB files) available. One of the major advantages of installing an app via an app store is to receive future software updates automatically.
  • Page 39 • Ubuntu You can acquire Kiosc Editor from the Snapcraft store: https://snapcraft.io/kiosceditor Alternatively, it can be installed by using the command-line: snap find kiosceditor snap install kiosceditor To update the apps later on via the command-line type: snap refresh kiosceditor Ubuntu 20.04 LTS is recommended.
  • Page 40 (a) File (b) Clipboard (c) Undo (d) Options Figure 4.2: Menu bar 4.2.2 Pages Your design needs at least one page. Add more pages by pressing the + button in figure 4.3. The Up and Down buttons allow you to change the order of the pages.
  • Page 41 4.2.3 Elements Controls like buttons, faders, encoders, and others are called Elements (see figure 4.4). A layout is basically created by dragging several Elements into the Pages. Figure 4.4: Elements More information on each element can be found in appendix A. The available Elements include: Button The button can be used to send a bool value (ON/OFF)
  • Page 42 Fader The fader can send a range of values. The range can be set using the Min and Max values. The type of value can be set to a float or an integer. A fader can simply be resized to get a horizontal fader. Displayed value can be changed between numeric value and percentage.
  • Page 43 Colourpicker 16 The Colourpicker 16 has sixteen colours to choose from. These are sent as OSC colour value, or via UDP/TCP using Hex #RRGGBB. ColourSpectrum The Colourspectrum has many colours to choose from. These are sent as OSC colour value, or via UDP/TCP using Hex #RRGGBB.
  • Page 44 ON or 1 when checked, and OFF or 0 when unchecked. Image The image element is perfect for adding your own logo to your Kiosc layout. It behaves similar to the button element, so it can be used to create custom buttons.
  • Page 45 4.2.4 Images A Page can have a background image. Also, Image Element can display an image. To use images in your design, you first have to import them into the images list (see figure 4.5). Add images by pressing the + button. Images are read from a specific folder.
  • Page 46 4.2.5 Appearance Properties This section allows you to change the (default) appearance of the page or se- lected Elements. Figure 4.6: Appearance properties Screen Size Figure 4.7: Setting the Screen Size Before starting to design your dashboard it is recommended to set the screen size for your layout.
  • Page 47 Visible in selector Currently only applies to pages and buttons. When selected, the page or button will not be shown on the device running Kiosc. Useful for hiding work-in- progress pages or special buttons. Colours The colour of the Element can be changed by setting the RGB fields in figure 4.8.
  • Page 48 Pin Protect The access to some pages can be locked via a requested password. To use it, the Pin Protect option must be activated and a Pin must be set in the Kiosc app or Kiosc Touch. Percentage Select this option if you want your fader to display a percentage value instead of the numeric value.
  • Page 49 OSC/UDP/TCP When the user clicks on a button in Kiosc, or controls any other element, it typically sends an OSC, UDP or TCP message to an external device. Which message is send out is determined by the OSC, UDP or TCP settings (see figure 4.13).
  • Page 50 IP and port in the beside input. Note that when the individual target is activated the TCP tag will not be sent to the IP addresses set in the TCP target list of KIOSC. Figure 4.14: TCP individual target...
  • Page 51 Open Page In Kiosc you can use a button or an image to switch between layout pages. A page doesn’t have to be set as Visible to be selectable and displayed via a button.
  • Page 52 4.3.2 Layout This is where you can view and edit the currently selected page. After dragging in an element from the Elements menu on the right, it can be resized by selecting the element, and dragging the small square located at the corner of the element. It can be removed by dragging it back to the Elements menu or pressing Delete on your keyboard.
  • Page 53 The size of the grid can be specified in the size field. Local IP Addresses A list with local IP addresses used by the computer running the Kiosc Editor. This information can be useful when trouble shooting network issues. Clients...
  • Page 54 Feedback Feedback in the Kiosc app is created by having the external equipment sending messages back to Kiosc. The feedback message should match the Tag of the Element. More information on which element supports which kind of feedback can be found in appendix A.
  • Page 55 File Locations When Kiosc is running in Remote mode there are no files involved, however, when running in File mode Kiosc must open a file that has been created by the Editor. Apps distributed by app stores are not allowed to access files outside this des- ignated location.
  • Page 56 E.g. Apple iTunes can copy files to an iOS device. To make copying files to Kiosc on a mobile device more convenient, Kiosc is ca- pable to connect to a Kiosc Editor under Remote mode and subsequently save it as a local file in File mode.
  • Page 57 4. Save the file by pressing the Save button.
  • Page 58 Appendices...
  • Page 59 Appendix A Elements This chapter will give a more detailed explanation of each element’s ability to send and receive various protocols.
  • Page 60 Page The Page is not a real element but can be used to send messages when displayed. It can also be displayed using feedback messages. The following sections will give a detailed explanation about the send and receive capabilities of a Page. A.1.1 Send Type...
  • Page 61 Type Function Property Value Down Value Up Bool Control Bool Control Toggle Integer Control Integer Control Toggle Integer Number Integer Toggle Number Number UDP and TCP Type Function Property Value Down Value Up Example None Tag only my-button None Toggle Tag only Tag only my-button...
  • Page 62 A.2.2 Feedback Feedback can be sent to a button using its tag. The type of message determines which attribute of the button it changes. The following attributes of a button can be set using feedback: • Visual state The visual state of a button can be used as feedback to the user, indicating for example if a light or cue is active.
  • Page 63 CheckBox The check box can be used to sent various messages. It can be controlled using feedback messages. The following sections will give a detailed explanation about the send and receive capabilities of a check box. A.3.1 Send Type Function Value Checked Value Unchecked Bool...
  • Page 64 Type Value Controls Bool On/Off State Integer State String text Label Colour colour Colour UDP and TCP Type Value Controls Example Bool On/Off State my-check=on Integer State my-check=1 String text Label my-check=awesome Colour HEX RGB colour Colour my-check=#FF00FF Fader The fader element can be used to sent various control values. It can be controlled using feedback messages.
  • Page 65 A.4.2 Feedback Feedback can be send to a fader using its tag. The type of message determines which attribute of the fader it changes. The following attributes of a fader can be set using feedback: • Value The current value of a fader can be set by a feedback message, for example to indicate the current intensity of a playback.
  • Page 66 Encoder The encoder element can be used to sent various control values. It can be controlled using feedback messages. The following sections will give a detailed explanation about the send and receive capabilities of the encoder element. A.5.1 Send Type Function Value Range...
  • Page 67 Type Value Controls Float Min/Max Value Integer Min/Max Value String text Label Colour colour Colour UDP and TCP Type Value Controls Example Float Min/Max Value my-encoder=0.75 Integer Min/Max Value my-encoder=190 String text Label my-encoder=text Colour HEX RGB colour Colour my-encoder=#FF00FF...
  • Page 68 Axis The axis element can be used to sent position values in a 2 float number between -1.00 and 1.00 separated by a coma (,) format. It can be controlled using feedback messages. The following sections will give a detailed explanation about the send and receive capabilities of the axis element.
  • Page 69 UDP and TCP Type Value Controls Example Float 0.00,0.00 Value my-axis=0.75,-0,27 Colour HEX RGB colour Colour my-axis=#FF00FF...
  • Page 70 Text The Text element can be used to send text messages. It can be controlled using feedback messages. The following sections will give a detailed explanation about the send and receive capabilities of the Text element. A.7.1 Send Type Function Value String text...
  • Page 71 Indicator The indicator element can be seen as a virtual LED. It can only be used for visual feedback, it does not send any message. The indicator can be changed using feedback messages. The following sections will give a detailed explanation about the receive capabilities of the indicator element.
  • Page 72 UDP and TCP Type Value Controls Example Bool On/Off State my-indicator=on Integer 0 or lower State (Off) my-indicator=-10 Integer 1 or higher State (On) my-indicator=1 Float 0 or lower State (Off) my-indicator=0 Float 0.001 or higher State (On) my-indicator=0.5 Colour HEX RGB colour Colour my-indicator=#FF00FF...
  • Page 73 Image The image element can be used to send various messages. It can be controlled using feedback messages. The following sections will give a detailed explanation about the send and receive capabilities of the image element. A.9.1 Send Type Function Property Value Down Value Up...
  • Page 74 Type Value Controls Bool On/Off Alpha Float 1.00/0.00 Alpha UDP and TCP Type Value Controls Example Bool On/Off Alpha my-image=on Float 1.00/0.00 Alpha my-image=0.5...
  • Page 75 A.10 Label The label element can only be used for feedback, it does not send any message. The label can be changed using feedback messages. The following sections will give a detailed explanation about the receive capabilities of the label element. A.10.1 Feedback Feedback can be sent to a label using its tag.
  • Page 76 Type Function Value Range Colour Control HEX RGB colour #000000-#FFFFFF UDP and TCP Type Function Value Range Example String Control HEX RGB colour #000000-#FFFFFF my-color=#800080 A.11.2 Feedback Feedback can be sent to a ColorSpectrum using its tag. • Colour The color value can be set via feedback if the ColorSpectrum element has such value.
  • Page 77 UDP and TCP Type Function Value Range Example String Control HEX RGB colour #000000-#FFFFFF my-color=#800080 A.12.2 Feedback Feedback can be sent to a color picker using its tag. • Label The label is a string of text. The default value is set in the showfile, but it can be temporarily changed using a feedback message.
  • Page 78 UDP and TCP Type Function Value Range Example Colour HEX RGB colour Colour my-wheel=#800080 A.13.2 Feedback Feedback can be sent to a WheelRGBW element using its tag. • Label The label is a string of text. The default value is set in the showfile, but it can be temporarily changed using a feedback message.
  • Page 79 UDP and TCP Type Function Value Range Example Float Control decimal number 0.0-1.0 my-temp=0,82 A.14.2 Feedback Feedback can be sent to a WheelRGBW element using its tag. The label of the element can be set using feedback: • Label The label is a string of text. The default value is set in the showfile, but it can be temporarily changed using a feedback message.
  • Page 80 UDP and TCP Type Value Controls Example Colour HEX RGB colour Colour my-date=#800080 A.16 Color elements values A.16.1 ColorSpectrum Any color with RGB channels is available: #XXXXXX (with X from 0 to F). A.16.2 Color Pickers ColorPicker8 The following colors are available: #FF0000 #FF00FF #7F007F...
  • Page 81 Appendix B This chapter will give the list of all the API commands you can send to KIOSC and what will be its feedback. The API commands are only compatible with KIOSC Touch.
  • Page 82 Switch to page index of the layout Feedback The Kiosc is able to send feedback to external equipment using its API, so called ’clients’. The Kiosc keeps a memory of the last eight OSC clients, the last eight UDP clients and last eight TCP clients.
  • Page 83 Feedback is automatically sent to a device which uses the OSC, UDP or TCP API. If the external device is also a Visual Productions unit then the feed- back message could be interpreted by the external unit a new command. This can result in another feedback message being generated.

This manual is also suitable for:

Kiosc touch