Lightware RAP-B511-EU Page 75 User Manual Download

Page: 75 / 120

7. LW3 Programmers’ Reference

RAP-B511 series

– User's Manual

Applied firmware package: v1.1.0b3b3 | LDC software: v2.5.1b5

Button Icon and IDs

i10

i11

i12

i13

i14

i15

i16

i17

i18

i19

i20

i21

i22

i23

i24

i25

i26

i27

i28

i29

i30

i31

i32

i33

i34

i35

i36

i37

i38

i39

i40

i41

i42

i43

i44

i45

i46

i47

i48

i49

i50

i51

i52

i53

i54

i55

i56

i57

i58

i59

i60

i61

i62

i63

i64

i65

i66

i67

i68

i69

i70

i71

i72

i73

i74

i75

i76

i77

i78

i79

i80

i81

i82

i83

i84

i85

i86

i87

i88

i89

i90

i91

i92

i93

i94

i95

i96

i97

i98

i99

i100

i101

i102

i103

i104

i105

i106

i107

i108

i109

i110

i111

i112

i113

i114

i115

i116

i117

i118

i119

i120

i121

i122

i123

i124

i125

i126

i127

i128

i129

i130

i131

i132

i133

i134

i135

i136

i137

i138

i139

i140

Example

SET /MANAGEMENT/UI/BUTTONS/BUTTON2.IconId=i139

pw /MANAGEMENT/UI/BUTTONS/BUTTON2.IconId=i139

7.7.7.

Set the Label for the Button

Command and Response

SET·/MANAGEMENT/UI/BUTTONS/

<btn_ID>

. IconId=

<row1>

;

<row2>

;

<row3>

pw·/MANAGEMENT/UI/BUTTONS/

<btn_ID>

. IconId=

<row1>

;

<row2>

;

<row3>

Parameters

Identifier

Parameter description

Parameter values

<row1>

;

<row2>

;

<row3>

It defines the displayed text of

the button in the Miniweb or the

LDC layout.

Maximum three rows can be displayed for one

button separated with semicolon. 30 ASCII

characters are allowed for all rows.

Example

SET /MANAGEMENT/UI/BUTTONS/BUTTON1.IconId=DP;laptop;on

pw /MANAGEMENT/UI/BUTTONS/BUTTON1.IconId=DP;laptop;on

7.7.8.

Clear the Button Style

The buttons style deleted when IconId has no parameter.

Command and Response

SET·/MANAGEMENT/UI/BUTTONS/

<btn_ID>

. IconId=

pw·/MANAGEMENT/UI/BUTTONS/

<btn_ID>

. IconId=

Example

SET /MANAGEMENT/UI/BUTTONS/BUTTON1.IconId=

pw /MANAGEMENT/UI/BUTTONS/BUTTON1.IconId=

7.7.9.

Button Status Indicators

Query the Latch

Command and Response

GET·/MANAGEMENT/UI/BUTTONS/

<btn_ID>

/BUTTON.Latch

pr·/MANAGEMENT/UI/BUTTONS/

<btn_ID>

/BUTTON.Latch=

<btn_latch_status>

Parameters

Identifier

Parameter description

Parameter values

<btn_latch_status>

When the button is pressed, the latch property toggles

between true and false values every time. This

property operates independently of the

Set the Button

Operation Mode

True

False

Example

GET /MANAGEMENT/UI/BUTTONS/BUTTON1/BUTTON.Latch

pw /MANAGEMENT/UI/BUTTONS/BUTTON1/BUTTON.Latch=false

laptop

<row1>

<row2>

<row3>



 



Summary of Contents for RAP-B511-EU

Page 1: ...RAP B511 EU K W S RAP B511 UK K W S RAP B511 US K W S User s Manual Room Automation Panel v2 0 20 01 2021 ...

Page 2: ...mote the sustainable reuse of material resources Household users should contact either the retailer where they purchased this product or their local government office for details of where and how they can take this item for environmentally safe recycling Business users should contact their supplier and check the terms and conditions of the purchase contract This product should not be mixed with ot...

Page 3: ...re Device Controller LDC software 2 5 1b5 Lightware Device Updater v2 LDU2 Software 2 7 1b3 Firmware package 1 1 0b3b3 Hardware 1 1 Document revision v2 0 Release date 20 01 2021 Editor Laszlo Zsedenyi About Printing Lightware Visual Engineering supports green technologies and Eco friend mentality Thus this document is made for digital usage primarily If you need to print out few pages for any rea...

Page 4: ... Button 36 5 4 3 Configurations of the Rotary 38 5 5 Control Menu 39 5 5 1 RS 232 39 5 5 2 GPIO 40 5 5 3 Ethernet 41 5 5 4 Infra 43 5 5 5 Macros 44 5 5 6 Variables 45 5 6 Event Manager 47 5 6 1 Event Manager in the RAP B511 series 47 5 6 2 The Event Editor 48 5 6 3 Create or Modify an Event 48 5 6 4 Special Tools and Accessories 50 5 6 5 Clear One or More Event s 51 5 6 6 Export and Import Events ...

Page 5: ...Tool Kit 81 7 12 1 Setting the Delay 81 7 12 2 Setting the Name of the Event 82 7 12 3 Enable the Event 82 7 12 4 Triggering a Condition 82 7 12 5 Querying the Condition Counter 82 7 12 6 Querying the Condition Trigger Counter 83 7 12 7 Testing an Action 83 7 13 Variable Management 83 7 13 1 Value Assignment 83 7 13 2 Addition and Subtraction Add Method 83 7 13 3 Addition and Subtraction Cycle Met...

Page 6: ...mediate Event Action 99 7 22 GPIO Port Configuration 100 7 22 1 Set the Direction of a GPIO Pin 100 7 22 2 Set the Output Level of a GPIO Pin 100 7 22 3 Toggle the Level of a GPIO Pin 100 7 23 LW3 Commands Quick Summary 101 8 FIRMWARE UPGRADE 106 8 1 Introduction 107 8 2 Preparation 107 8 2 1 About the Firmware Package LFP2 File 107 8 2 2 LDU2 Installation 107 8 3 Running the Software 108 8 4 The ...

Page 7: ... Thank you for choosing Lightware s RAP B511 series device In the first chapter we would like to introduce the device highlighting the most important features in the coming sections ç Description ç Model Comparison ç Box Contents ç Optional Accessories ç Compatible Devices ç Features of the Device ç Typical Application ...

Page 8: ...K wall box RAP B511 UK W white RAP B511 UK S brushed steel RAP B511 US K black Double US wall box RAP B511 US W white RAP B511 US S brushed steel RAP B511 EU K Button Outlet box type Room Automation Panel Faceplate color Key or Black 11 buttons altogether 5 buttons in the first line 7A000941 7 2017 8 2018 9 2019 A 2020 B 2021 C 2022 D 2023 E 2024 F 2025 6 digit running sequence number Month of the...

Page 9: ... Third party control systems may send IR control commands to endpoints turning them on and off or switching their inputs LDC The Lightware Device Controller LDC application keeps receiving upgrades adding new features and tools The latest edition of LDC has gotten more intuitive user friendly smarter and has a modern user interface The LDC is available for both Windows and macOS operating systems ...

Page 10: ... 1b5 1 7 Typical Application VINX Application Example Conditions Actions Button Process Source Switching Scheduling Display Projector On Off Volume Meeting Room Application Example Conditions Actions Button Process Source Switching Scheduling Display Projector On Off Occupancy Sensor Lamp On Off Volume ...

Page 11: ...anual 11 Applied firmware package v1 1 0b3b3 LDC software v2 5 1b5 Conference Room Application Example Conditions Actions Button Process Source Switching Scheduling Display Projector On Off Occupancy Sensor Lamp On Off Screen Up Down Volume ...

Page 12: ...2 Applied firmware package v1 1 0b3b3 LDC software v2 5 1b5 2 Product Overview The following sections are about the physical structure of the device input output ports and connectors buttons and status LEDs ç Front View ç Rear View ç Special Functions ...

Page 13: ...dial knob full bright As the jog dial is rotated right and the volume increases the LEDs turn on one by one One level means half brightness The picture on the left shows that the volume is set 11 half bright off 3 Rotary knob Jog dial for volume control on a 16 level scale or it can be programmed for other controlling purposes by turning and clicking the knob 4 Mute LED It gives feedback about the...

Page 14: ...n for reloading the factory default settings is available from HW v1 1 2 3 2 Restarting the Device Step 1 Keep the 5th and the 9th button pressed for 10 seconds Step 2 Release the buttons The mute LED lights up when the device restarts 4 2 3 1 2 3 3 Entering Bootload Mode It may happen that the firmware upgrade process is unsuccessful and the device cannot be switched to bootload mode automaticall...

Page 15: ...1 0b3b3 LDC software v2 5 1b5 3 Installation The chapter is about the installation of the device and connecting to other appliances presenting also the mounting options and further assembly steps ç Mounting Options ç Electrical Connections ç Powering Options ç Connecting Steps ...

Page 16: ...rd switch outlet box See more details about the exact sizes of the device in the Mechanical Drawings section Model name refers to the box type see the recommended box types for the models in the table below Model Outlet box type RAP B511 EU Double EU wall box 65mm e g Legrand 0 801 22 0 800 52 2x0 801 51 2x0 801 61 0 819 42 RAP B511 UK Double UK wall box e g Appleby SB628 Galvanised Steel Knockout...

Page 17: ...th red color OR four screws marked with yellow color in the holes Front plate RAP B511 EU RAP B511 EU Step3 Insert the RAP B511 EU into the Outlet box and position it to get the holes aligned Step 4 Fasten the front side of the device to the Outlet box by fitting all the screws Step 5 Place back the Front plate to the Button panel See more details about the exact sizes of the RAP B511 EU in the Me...

Page 18: ...ce the screws marked with yellow in the holes RAP B511 UK Front plate RAP B511 UK Step3 Insert the RAP B511 UK into the Outlet box and position it to get the holes aligned Step 4 Fasten the front side of the device to the Outlet box by fitting all the screws Step 5 Place back the Front plate to the RAP B511 UK See more details about the exact sizes of the RAP B511 UK in the Mechanical Drawings sec...

Page 19: ...e four screws marked with yellow in the holes Front plate RAP B511 US RAP B511 US Step3 Insert the RAP B511 US into the Outlet box and position it to get the holes aligned Step 4 Fasten the front side of the device to the Outlet box by fitting all the screws Step 5 Place back the Front plate to the RAP B511 US See more details about the exact sizes of the RAP B511 US in the Mechanical Drawings sec...

Page 20: ...color white green white orange 3 white green white orange 1 blue blue 4 white blue white blue 5 brown 8 brown white brown 7 white brown green orange 6 green orange 2 3 2 Electrical Connections 3 2 1 48V DC Connection RAP B511 series is built with 2 pole Phoenix connector for 48V DC 1A power connection 2 pole Phoenix connector and plug pin assignments 3 2 2 GPIO General Purpose Input Output Ports R...

Page 21: ...one Matrix or Matrix board PoE IN Powering by a matrix board over the CATx TPS cable The output board needs to be powered by an external PSU Connect it to the POE IN labeled RJ45 connector TPS2 I O board with PoE extension P INFO Over the CATx cable the Ethernet communication is transmitted Local adaptor and remote power PoE out Remote power injector PoE in Matrix board PoE in 3 4 Connecting Steps...

Page 22: ...5 1b5 4 Device Concept The following chapter describes the features of the device with a few real life examples ç General Concept ç Inputs 1 User Interactions ç Inputs 2 Automation Options ç Outputs Actions ç Settings for Other Interfaces ç The Event Manager Feature ç Basic IT Security ç Batch Commands ...

Page 23: ...oups are available one group may contain max 11 buttons Example Select video input on a crosspoint or switcher One input can be active at the same time Explanation When the button is pressed the interaction state changes true and the interaction state of the other group members are false When the button is released the interaction state does not change 4 1 General Concept Room automation panel is ...

Page 24: ...lume values are the conditions which are assigned to the control commands e g SET MEDIA PORTS VIDEO O2 ANALOGAUDIO VolumedB 96 x0d x0a When the rotary reaches the proper position the action will be executed The control command can be sent over RS 232 or Ethernet in this case the IP address of the target device is needed LWR Volume Control Schema supports to load the LW3 command list automatically ...

Page 25: ...Source DHCP server Local network with NTP server Source NTP time Source NTP time Set the RTC manually timezone setting daylight saving setting Local Time Elements Source RTC time Years Months Days Hours Weekday 4 3 2 RS 232 Recognizer This tool is able to recognize and store the incoming RS 232 message until the previously defined string delimiter has arrived or the timeout has elapsed after the l...

Page 26: ... Ethernet That message will be recognized by the RAP B511 and will be used as a Condition in Event Manager How to set up the RAP Step 1 Configure the recognizer for the communication by the LDC see the Ethernet section or by LW3 protocol commands see the TCP Message Recognizer section Define the desired device as a TCP client The Projector is saved as C1 in this example Step 2 Create the following...

Page 27: ...tton4 are in the same radio group When Button2 is pressed its interaction state changes true and the other s interaction states change false If the LED function for false state is off by all buttons in the group the LEDs of Button3 and Button4 will turn off Momentarily LED function The Button LED can get a momentarily function This overwrites the default function for a while Duration time has to b...

Page 28: ... Input Output port is a multifunctional input output interface to control the RAP B511 or third party devices and peripherals You can establish connection between the controller controllable device and the RAP B511 by the 4 pole Phoenix connector Three pin s direction is configurable independently based on needs of the application When the GPIO pin is used as an output it is able to send a TTL sig...

Page 29: ...r section This interface only supports LW3 protocol See more details about the Lightware protocols in LW3 Programmers Reference sections Establish the connection via USB to Lightware Device Updater v2 software and perform Firmware Upgrade 4 5 Settings for Other Interfaces 4 5 1 Serial Interface Technical Background Serial data communication can be established via the local RS 232 port Phoenix conn...

Page 30: ... is launched For example in a meeting room we have the following situation Signal is present on an input port A GPIO pin state becomes low by an external device If the two Conditions are present at the same time the Action is launched Just create the two Conditions into separate Events then create a third Event select the two Conditions and define the Action See the Combine Links section for the s...

Page 31: ...Send option or Querying parameters Receive option to from the Lightware device Below table shows the protection levels of these features ATTENTION Be careful when combining these functions improper settings may cause malfunction Most of these feature are available in LDC see the Settings Menu section IP Port Function MAC Filter Cleartext Login IP Port Block 80 HTTP Post Get 81 LW3 control miniweb ...

Page 32: ...uter through the Ethernet and RS 232 port using Lightware Device Controller LDC The software can be installed on a Windows PC or macOS The application and the User s manual can be downloaded from www lightware com ç Install and Upgrade ç Running the LDC ç Establishing the Connection ç UI Config Menu ç Control Menu ç Event Manager ç Settings Menu ç Built in Miniweb ç Configuration Cloning Backup Ta...

Page 33: ...rent and the update version number can be seen at the top of the window and they are shown in this window even with the snapshot install The Update window can also be opened by clicking the About icon and the Update button Step 2 Set the desired update setting in the Options section If you do not want to check for the updates automatically uncheck the circle which contains the green tick If you wa...

Page 34: ...conds The feature helps to identify the device itself The Ethernet tab consists of two lists Favorite Devices You can add any Lightware device that is connected via Ethernet and no need to browse all the available devices Devices can be added by pressing the Add button or marking the desired device by the symbol in the All Devices list All Devices The Lightware devices are listed which are availab...

Page 35: ...mary of the Button Interactions This section contains all the defined events of the selected button For more details about it see Button Interactions section 5 Advanced View button Displaying Advanced View Window showing the Terminal window and the LW3 protocol tree 6 Configure button section The tabs consist of actions and conditions which can be set to the selected button The tab denomination de...

Page 36: ...ction 5 4 2 Configure Button This section provides a layout where button functions can be set quick and easy The first two configuration tabs are for setting the Actions outputs of the chosen button In this case the trigger condition is always the same The second two tabs are for setting the Feedbacks conditions or inputs and the action is fix The tab denomination depends on the button operation m...

Page 37: ...ontains the web address of the Miniweb page It can be saved in png Button Interactions This section provides an overview of all defined events of the selected button One line represents one event It displays the delay time between the action and the condition the condition or the action with the parameters the event number where the current setting is saved The icon shows that the event was not cr...

Page 38: ...ee Volume Control Schema Table Write the audio port number e g I2 or O8 Click Set to confirm Commands are loaded into the list The Send unmute when volume changed option allows setting the volume while the controlled device is in muted state If the option is enabled the unmute command is sent the LED is switched off and the volume setting command is sent If the option is unchecked only the volume ...

Page 39: ...RS 232 RS 232 Tab in Control Menu The following settings and functions are available both on local and TPS serial ports Operation mode Control Command Injection or Disconnected for more details about serial interface modes see the Serial Interface section Baud rate 4800 7200 9600 14400 19200 38400 57600 115200 Data bits 8 or 9 Parity None Odd or Even Stop bits 1 1 5 or 2 Command injection enable o...

Page 40: ...r easily defined delimiter in the incoming data but there is a time gap between the messages Text The recognized message in ASCII format Hex The recognized message in hex format Hash Binary data that is mapped from the original message The length of the hash is shorter and the same message results the same hash Working Method A message got recognized from the incoming data if one of the following ...

Page 41: ...for processing the response e g querying a parameter status http The feature is available also by LW3 commands see the HTTP Messaging section HTTP Clients tab in the Control Ethernet men When you press the enter in the Http header or Http body text box the r n is added automatically new 5 5 3 Ethernet Ethernet Ports Two ports are displayed in the Ethernet settings PoE in Eth and PoE out Eth You ca...

Page 42: ... saved from the first bit until the delimiter or the data between the two delimiters Timeout If there is no response within the set time interval milliseconds the data will be accepted that is received from the last delimiter Trigger Action If data is received that is closed with the recognized delimiter an Action can be run Type the number of the Event without letter E new SalvoHttp Status Page R...

Page 43: ...e fingerprint and or the name of the IR code Cancel canceling the fingerprint Learn storing the fingerprint of the detected IR code Detected IR fingerprints The IR fingerprints are displayed in the box that can be emptied by the Clear button 20 fingerprints can be stored in the device at the same time Each of them can be ordered to an action in Event Manager Learning IR Codes Step 1 Click on the L...

Page 44: ...TION The preset and the macros of the selected slot will be erased If there is a macro with the same name already in the device it will be removed and the new one will be available myDeviceMacros Begin myMacro1 CALL MEDIA VIDEO XP unmuteSource I3 CALL MEDIA VIDEO XP switch I3 O1 I3 O2 End myMacro1 Begin myMacro2 CALL MEDIA VIDEO XP unmuteSource I4 CALL MEDIA VIDEO XP switch I4 O1 I4 O2 End myMacro...

Page 45: ...uld be lower than the min setting the min will be valid Cycle button the operand will be added to the current value If the result would be beyond the limit min max the value will be stepped to the other end of the interval Examples The following shows the difference between the Add and the Cycle options The input values are the same in both cases Min 1 Max 5 Operand 1 In Add case when the value hi...

Page 46: ... brackets which will be skipped Ignored part custom_text User defined text Examples Scanned property MANAGEMENT STATUS CpuTemperature 46 C 0 75 0 79 3 48 pattern Scan result Variable type Comment s 46 Number Scanned from the first character till the first whitespace character 5c 46 C String The first 5 characters scanned 18c 4c 3 48 String The first 18 characters skipped then 4 characters scanned ...

Page 47: ...d an action are set and the Event is enabled the bar is displayed in green Control menu Event Manager tab eventmanager 5 6 1 Event Manager in the RAP B511 series The functionality of the Room Automation Panel is based on the Event Manager UI config page provides an interface where the events can be set easily and they are saved in the Event Manager Events from the UI config page are listed backwar...

Page 48: ...elow the buttons 8 Action test The set action can be tested to see the working method in the practice 5 6 3 Create or Modify an Event Wizard Mode The wizard mode lists the most common conditions and actions so the user does not have to look for LW3 nodes and properties Step 1 Click on the Edit button of the desired Event the Event editor is displayed Step 2 The wizard mode is displayed as default ...

Page 49: ...llows if one of the set conditions becomes true while the other conditions are fulfilled then the set Action is launched The Combine Links tool allows setting these Conditions Follow the steps below Step 1 Create individual Conditions in separate Events Step 2 Create a new Event and navigate to the Combine Links tab in the Editor Step 3 Select up to four Conditions in the left panel Step 4 Set the...

Page 50: ... time interval only if the Condition still exists Continuously true when the Condition is detected the Action is launched after the set time interval only if the Condition has been existing continuously The available delay settings of an Event TIPS AND TRICKS Show advanced expressions option is a useful tool when you look for the path or value of a property but just the expression is displayed The...

Page 51: ...e generated file is a simple text file which contains LW3 protocol commands The file can be viewed by a simple text editor e g Notepad ATTENTION Editing the file is recommended only for expert users Import all the Events Step 1 Press the Import button above the Event list Step 2 The Open dialog box will appear Select the desired folder and file then press the Open button 5 7 Settings Menu 5 7 1 St...

Page 52: ...re is available from FW package v1 1 0b3 Another level of the security is the MAC Filtering tool You can create a list of network devices based on the MAC address which are allowed macfilter new Controlling the device Send option or Querying parameters Receive option to from the Lightware device Do not forget to press the Apply changes button to store the new settings ATTENTION The first three lin...

Page 53: ...r It means that the RAP B511 is permitted to get time information from an NTP server The device time synchronized repeatedly and automatically In this case the NTP server address entry field is active where the IP address or URL of the NTP server can be typed manually Click to set to save the address The current setting is also displayed Enable GET NTPfrom DHCPserver means when that DHCP server as...

Page 54: ... are not available in the Built in miniweb page because it is designed for common usage To activate the Default Miniweb page click on the Upload default button in the Settings menu Status tab The website can be easily reached Write the IP address of the device in the search bar of the web browser Launch the LDC connecting to the device navigate to Settings Status or UI Config Style and pressing th...

Page 55: ... Backup Tab The configuration cloning of Lightware LW3 devices is a simple method that eliminates the need to repeatedly configure certain devices to have identical non factory settings If the devices are installed in the same type of system multiple times then it is enough to set up only one device to fit the user s needs and then copy those settings to the others thus saving time and resources A...

Page 56: ...ecommended for expert users See the entire list of saved data in the Content of Backup File section 5 9 3 Upload the Settings to a Device Restore WARNING Please note that the settings will be permanently overwritten with the restored parameters in the device Withdrawal is not possible ATTENTION The cloning is successful when the backup file is downloaded from the same type of source device as the ...

Page 57: ...or of each item depends on the type of the command and response The content of the window can be emptied by the Clear button If the Autoscroll option is ticked the list is scrolled automatically when a new line is added 5 Command line Type the desired command and execute it by the Send button Clear all current commands and responses in the Terminal window by the Clear button The commands typed in ...

Page 58: ...can be controlled through a reduced command set of LW2 protocol commands to ensure the compatibility with other Lightware products The supported LW2 commands are described in this chapter ç Protocol Description ç Instructions for the Terminal Application Usage ç General LW2 Commands ç Network Configuration ç GPIO Port Configuration ç LW2 Commands Quick Summary ...

Page 59: ...n 2 digit ASCII format loc Location number in 1 2 or 3 digit ASCII format id id number in 1 or 2 digit ASCII format id2 id number in 2 digit ASCII format CrLf Carriage return Line feed 0x0D 0x0A Space character 0x20 Each command issued by the controller Each response received from the router The command has the same arguments on the input ports and the output port as well 6 2 Instructions for the ...

Page 60: ...CrLf Ȩ CF DESC CrLf Ȩ Ȩ CF END CrLf Example ȩ fc Ȩ CF RAP B511 US W v1 0 3b2 Ȩ CF END The device has one control panel 6 3 General LW2 Commands 6 3 1 Querying the Supported Commands The LW2 commands supported by the device can be queried by this command Command and Response producttype ȩ LCMD Ȩ LCMD command description CrLf Ȩ Ȩ LCMD END CrLf Example ȩ lcmd Ȩ LCMD LCMD List all commands Ȩ LCMD PING...

Page 61: ...l voltages and measured temperature values are shown Command and Response status ȩ ST Ȩ ST DESC CrLf Example ȩ st Ȩ ST CPU 3 32V 4 98V 1 81V 3 36V 44 37C 44 38C 6 3 11 View Installed Board Shows the hardware name and revision of the installed cards Command and Response ȩ IS Ȩ SL 0 MB_DESC CrLf Ȩ SL END CrLf Example ȩ is Ȩ SL 0 RAP B511 Ȩ SL END The device reports its motherboard slot 0 6 3 12 Rest...

Page 62: ...y typing the ip_address command The response contains the fix IP address that is stored in the device even if DHCP is enabled in this case this IP address is not valid 6 4 3 Setting the Subnet Mask Subnet mask can be set as follows Command and Response ȩ IP_NETMASK subnet_mask Ȩ IP_NETMASK subnet_mask CrLf Parameters See the Querying the Current IP Status section Example ȩ ip_netmask 255 255 255 0...

Page 63: ...ection for Each Pins GPIO pins can be configured as follows See more details about GPIO connector in the GPIO General Purpose Input Output Ports section Command and Response gpio ȩ GPIO pin_nr dir level Ȩ GPIO pin_nr dir level CrLf Parameters Parameter Parameter description Value Value description pin_nr GPIO pin number 0 3 static dir The direction of the communication I Input O Output level The l...

Page 64: ...on Test ȩ PING Querying the Serial Number ȩ S Compile Time ȩ CT Querying the Health Status ȩ ST View Installed Board ȩ IS Restarting the Device ȩ RST Restoring the Factory Default Settings ȩ FACTORY ALL Network Configuration Querying the Current IP Status ȩ IP_STAT Setting the IP Address ȩ IP_ADDRESS type ip_address Setting the Subnet Mask ȩ IP_NETMASK subnet_mask Setting the Gateway Address ȩ IP_...

Page 65: ...tions for the Terminal Application Usage ç Protocol Rules ç System Commands ç Cleartext Login Protection ç Time Settings ç Button Configuration ç Button LED Configuration ç Button Group Configuration ç Volume Control Configuration ç Event Manager Basics ç Event Manager Tool Kit ç Variable Management ç Ethernet Port Configuration ç Ethernet Tool Kit ç Ethernet Message Sending ç HTTP Messaging ç TCP...

Page 66: ...he device default 192 168 0 100 and the port number 6107 Step 4 Select the Raw connection type and open the connection Once the terminal window is opened you can enter the LW3 protocol commands which are listed in the following sections LW3 protocol command communication in a terminal window 7 3 Protocol Rules 7 3 1 LW3 Tree Structure and Command Structure examples 7 3 2 General Rules All names an...

Page 67: ...t the manual ç MAN MANAGEMENT UI LEDS LED1 TrueFunction æ pm MANAGEMENT UI LEDS LED1 TrueFunction 0 5 0 off 1 low 2 high 3 blink 4 slow blink 5 sine pulse 7 3 4 Prefix Summary DEFINITION The prefix is a 2 character long code that describes the type of the response The following prefixes are defined in the LW3 protocol Prefix Description Prefix Description n a node pm a manual for the property nE a...

Page 68: ...IA IR æ o MEDIA IR Get the Active Subscriptions ç OPEN æ os MEDIA IR S1 æ o MANAGEMENT UI BUTTONS BUTTON1 æ o MANAGEMENT UI LEDS LED1 æ o MANAGEMENT UI VOLUMECONTROL æ o MANAGEMENT LABEL Subscribe to Multiple Nodes ç OPEN MEDIA ETHERNET æ o MEDIA ETHERNET Unsubscribe from a Node ç CLOSE MEDIA ETHERNET æ c MEDIA ETHERNET Unsubscribe from Multiple Nodes ç CLOSE MEDIA ETHERNET æ c MEDIA ETHERNET 7 3 ...

Page 69: ...nd ASCII characters are allowed Longer names are truncated Example ç SET MANAGEMENT LABEL DeviceLabel RAP B511 æ pw MANAGEMENT LABEL DeviceLabel RAP B511 7 4 3 Query the Serial Number Command and Response ç GET SerialNumber æ pr SerialNumber serial_nr Example ç GET SerialNumber æ pr SerialNumber 00009865 7 4 4 Query the Firmware Version Command and Response ç GET SYS MB FirmwareVersion æ pr SYS MB...

Page 70: ...æ mO CTRL MACROS run Example ç CALL CTRL MACROS run Macro1 æ mO CTRL MACROS run 7 5 Cleartext Login Protection DIFFERENCE This feature and below commands are available from FW package v1 1 0b3 This cleartext login tool allows setting a password for login thus any change in the device can be performed only after a successful login coming from any control interface RS 232 Ethernet etc The login is v...

Page 71: ...the setPassword method Example ç SET LOGIN LoginEnable true æ pw LOGIN LoginEnable true 7 6 Time Settings 7 6 1 Query the Timezone Command and Response ç SET SYS MB TIMEZONE Timezone timezone æ pw SYS MB TIMEZONE Timezone timezone Parameters timezone Time zone setting in POSIX TZ format Example ç SET SYS MB TIMEZONE Timezone CET 1CEST M3 5 0 2 M10 5 0 3 æ pw SYS MB TIMEZONE Timezone CET 1CEST M3 5...

Page 72: ...L Example ç GET SYS MB NTP ActiveNtpServer æ pr SYS MB NTP ActiveNtpServer pool ntp org 7 6 4 Set NTP server Command and Response ç SET SYS MB NTP NtpServer server_address æ pw SYS MB NTP NtpServer server_address Parameters server_address NTP server address IP address or URL Example ç SET SYS MB NTP NtpServer pool ntp org æ pw SYS MB NTP NtpServer pool ntp org 7 6 5 Synchronize with the NTP server...

Page 73: ...s in the year Scheduler time 5 18 19 Weekday Hours Minutes Example ç GET SYS MB RTC Years æ pr SYS MB RTC Years 2019 7 7 Button Configuration General parameters Identifier Parameter description Parameter values btn_ID Button identifier BUTTON1 11 7 7 1 Lock the Front Panel Functionality Command and Response ç SET MANAGEMENT UI ControlLock lock_status æ pw MANAGEMENT UI ControlLock lock_status Para...

Page 74: ...ion State This property gives immediate feedback about the button status which changes depending on the button mode When the button function is configured with Lightware Device Controller Software this parameter is set as a Condition in the Event Manager Command and Response ç SET MANAGEMENT UI BUTTONS btn_ID State btn_state æ pw MANAGEMENT UI BUTTONS btn_ID State btn_state Parameters Identifier P...

Page 75: ...rameter description Parameter values row1 row2 row3 It defines the displayed text of the button in the Miniweb or the LDC layout Maximum three rows can be displayed for one button separated with semicolon 30 ASCII characters are allowed for all rows Example ç SET MANAGEMENT UI BUTTONS BUTTON1 IconId DP laptop on ç pw MANAGEMENT UI BUTTONS BUTTON1 IconId DP laptop on 7 7 8 Clear the Button Style Th...

Page 76: ...gPress æ pr MANAGEMENT UI BUTTONS btn_ID BUTTON LongPress longpress_status Parameters Identifier Parameter description Parameter values longpress_status True when the button has been pressing more than 1 sec true The button has been pressed more than 1sec false The button has been pressed less than 1 sec Example ç GET MANAGEMENT UI BUTTONS BUTTON1 BUTTON LongPress æ pr MANAGEMENT UI BUTTONS BUTTON...

Page 77: ...Sine pulse Example ç SET MANAGEMENT UI LEDS LED11 TrueFunction 1 æ pw MANAGEMENT UI LEDS LED11 TrueFunction 1 Set the FalseFunction Here the LEDs behaviour can be defined when the button is pressed or released This property takes into consideration the Set the Button Interaction State If it is false btn_ID State false the LED will light according to this setting Command and Response ç SET MANAGEME...

Page 78: ...on states see Set the Button Interaction State section 1 11 Example ç SET MANAGEMENT UI GROUP G1 Active 1 æ pw MANAGEMENT UI GROUP G1 Active 1 7 10 Volume Control Configuration 7 10 1 Control Lock of the Jog Dial This property can disable the control function of the jog dial without locking the buttons Command and Response ç SET MANAGEMENT UI VOLUMECONTROL Enabled enabled æ pw MANAGEMENT UI VOLUME...

Page 79: ...TARY Clicked æ pr MANAGEMENT UI VOLUMECONTROL ROTARY Clicked 0 7 10 3 Mute the Volume Clicking on the jog dial changes the mute state and toggles on and off the mute LED Command and Response ç SET MANAGEMENT UI VOLUMECONTROL Mute mute_state æ pw MANAGEMENT UI VOLUMECONTROL Mute mute_state Parameters mute_state true or false Example ç SET MANAGEMENT UI VOLUMECONTROL Mute false æ pw MANAGEMENT UI VO...

Page 80: ...words if other input port is connected to O1 than I1 Example 3 Sometimes it is enough if the value of a property changes to anything In this case just put a to the end of the property ç SET EVENTS E3 Condition MEDIA UART RECOGNIZER Rx æ pw EVENTS E2 Condition MEDIA UART RECOGNIZER Rx 7 11 3 Setting a Condition by Linking Another Condition Command and Response ç SET EVENTS E loc Condition event_nr ...

Page 81: ...on Macro1 æ pw EVENTS E2 Action Macro1 7 12 Event Manager Tool Kit 7 12 1 Setting the Delay In most cases the Action is performed immediately after the Condition is detected But sometimes a delay is necessary between the Condition and the Action thus the following delay options are defined Command and Response summary ç SET EVENTS E loc ConditionTimeout time æ pw EVENTS E loc ConditionTimeout time...

Page 82: ... Name string æ pw EVENTS E loc Name string Parameters The string may contain letters A Z and a z numbers 0 9 special characters hyphen underscore _ and space up to 20 characters Longer string results an error unaccepted characters are skipped Example ç SET EVENTS E1 Name Projector_ON æ pw EVENTS E1 Name Projector_ON 7 12 3 Enable the Event Command and Response ç SET EVENTS E loc Enabled true false...

Page 83: ...xt or string is determined automatically based on the value If an operation cannot be performed e g adding number value to a string type variable error will be the response variables 7 13 1 Value Assignment Command and Response ç SET CTRL VARS V loc Value value æ pw CTRL VARS V loc Value value Parameters Parameter Parameter description Value Value description loc The location of the variable 1 30 ...

Page 84: ...cle Method The value of a numeric variable can be increased by adding a positive value or it can be decreased by adding a negative value Minimum and maximum values can be defined as limits This method has the feature that if the value hits the limit min max the value will be stepped to the other end of the interval Command and Response ç CALL CTRL VARS V loc cycle operand min max æ mO CTRL VARS V ...

Page 85: ...51 75 30 Case 4 76 100 40 Case 5 101 125 50 Case 6 126 150 60 Case 7 151 175 70 Case 8 176 200 80 Case 9 201 225 90 Case 10 226 255 100 7 13 5 Scan and Store This command can be used to get the value or a part of the value of an LW3 property The defined path will be scanned according to the pattern and the result will be the value of the variable number or string type Command and Response ç CALL C...

Page 86: ...cters s The original value of the variable postfix The text following the original value of the property optional Custom ASCII characters Example ç GET CTRL VARS V1 Value ç pw CTRL VARS V1 Value 01 ç CALL CTRL VARS V1 printf PWR s æ mO CTRL VARS V1 printf ç GET CTRL VARS V1 Value æ pw CTRL VARS V1 Value PWR01 The PWR string has been inserted before the original value 7 14 Ethernet Port Configurati...

Page 87: ... NetworkMask 255 255 255 0 7 14 6 Change the Subnet Mask Static Command and Response ç SET MANAGEMENT NETWORK StaticNetworkMask netmask æ pw MANAGEMENT NETWORK StaticNetworkMask netmask Example ç SET MANAGEMENT NETWORK StaticNetworkMask 255 255 255 0 æ pw MANAGEMENT NETWORK StaticNetworkMask 255 255 255 0 ç CALL MANAGEMENT NETWORK ApplySettings æ mO MANAGEMENT NETWORK ApplySettings INFO The applyS...

Page 88: ...description Values Value description loc Location of the address 1 8 The default values of 1 2 and 3 ensure that address resolution and device discovery continue to work after enabling the MAC filter MAC_address The MAC address of the device Unique value Hex format divided by a colon receive Enable disable the parameter querying option false or 0 The device is not allowed to query parameters from ...

Page 89: ...LTER HttpEnabled port_mode Example ç SET MANAGEMENT SERVICEFILTER HttpEnabled true æ pw MANAGEMENT SERVICEFILTER HttpEnabled true 7 15 4 HTTP Post Receiving Blocking This command is for blocking HTTP posts it is an additional protection for the Cleartext login function Command and Response ç SET MANAGEMENT SERVICEFILTER HttpEnabled port_mode æ pw MANAGEMENT SERVICEFILTER HttpEnabled port_mode Exam...

Page 90: ...message in ASCII format This method does not allow escaping or inserting control characters Command and Response ç CALL MEDIA ETHERNET tcpText IP_address port_no text æ mO MEDIA ETHERNET tcpText Example ç CALL MEDIA ETHERNET tcpText 192 168 0 103 6107 pwr_on æ mO MEDIA ETHERNET tcpText The pwr_on text is sent to the indicated IP port address 7 16 3 Sending a TCP Binary Message HEX format The comma...

Page 91: ... indicated IP port address INFO There is no need to insert a space or other separator character between the binary messages 7 17 HTTP Messaging DIFFERENCE This feature and below commands are available from FW package v1 1 0b3 Http post and put messages can be sent from the Lightware device for more integration with third party devices http new ATTENTION This feature means posting or putting HTTP m...

Page 92: ...CP client in the Lightware device three TCP clients can be run at the same time set the properties of the target TCP server Step 2 Set the DelimiterHex and the TimeOut settings for the proper message processing Step 3 Make sure theTCP IP port is opened in the target device think about Firewall settings in the network Step 4 Connect to the TCP server Working Method A message got recognized from the...

Page 93: ...0PWR_0100 Delimiter Delimiter Stored string 7 18 6 Setting the Timeout When the set time is elapsed after the last received message and delimiter was not detected the device saves the data into the Rx RxHex Hash properties The timeout setting is useful if there is no special or easily defined delimiter in the incoming data but there is a time gap between the messages Command and Response ç SET CTR...

Page 94: ...max 12 byte long recognized data string Example ç GET CTRL TCP C1 ActiveRx æ pr CTRL TCP C1 ActiveRx AudOut INFO Please note that the property contains the string until the ActivePropertyTimeout is elapsed only 7 18 11 Querying the Last Recognized Active Message Hex Command and Response ç GET CTRL TCP C loc ActiveRxHex æ pr CTRL TCP C loc ActiveRxHex recognized_hex Parameters The recognized_hex pa...

Page 95: ...200 5 38400 6 57600 7 115200 Example ç SET MEDIA UART P1 Baudrate 2 æ pw MEDIA UART P1 Baudrate 2 7 19 3 Databit Setting Command and Response ç SET MEDIA UART P1 DataBits databit æ pw MEDIA UART P1 DataBits databit Parameters Identifier Parameter description Parameter values databit Databit 8 8 9 9 Example ç SET MEDIA UART P1 DataBits 8 æ pw MEDIA UART P1 DataBits 8 7 19 4 Stopbits Setting Command...

Page 96: ...SCII format via RS 232 The command is for sending a command message in ASCII format This method allows escaping the control characters For more information see the Escaping section Command and Response message ç CALL MEDIA UART P1 sendMessage message æ mO MEDIA UART P1 sendMessage Example ç CALL MEDIA UART P1 sendMessage PWR0 æ mO MEDIA UART P1 sendMessage The PWR0 message is sent out via the P1 s...

Page 97: ... has been elapsed since receiving the last data bit In that case the not recognized data is kept in the memory up to 128 bytes If the DelimiterHex is detected later or the TimeOut parameter is set meanwhile the data appears in the Rx RxHex Hash and ActiveRx ActiveRxHex ActiveRxHash properties 7 21 1 Enable the Recognizer Command and Response ç SET MEDIA UART serial_port RecognizerEnable recognizer...

Page 98: ... Password Login name Delimiter hex format 3A Stored string 7 21 4 Querying the Last Recognized Message String The recognized message is stored as a string in the below property till the next recognized message or until the RECOGNIZER clear method is called TIPS AND TRICKS When this property is set as a condition in the Event Manager and the same strings follow each other the action will execute on...

Page 99: ...tiveRxHex recognized_hex Parameters The recognized_hex parameter is the recognized data in hex format Example ç GET MEDIA UART RECOGNIZER ActiveRxHex æ pr MEDIA UART RECOGNIZER ActiveRxHex 4C6F67696E3A 7 21 9 Set the Active Timeout This property is responsible for clearing the ActiveRx ActiveRxHex ActiveHash properties after the elapsed time Default value is 50ms Command and Response ç SET MEDIA U...

Page 100: ...IO P1 Direction I 7 22 2 Set the Output Level of a GPIO Pin Command and Response ç SET MEDIA GPIO gpio_port Output value æ pw MEDIA GPIO gpio_port Output value Parameters Identifier Parameter description Parameter values gpio_port GPIO port number P1 P3 value Value of the GPIO pin H High level L Low level Example ç SET MEDIA GPIO P1 Output H æ pw MEDIA GPIO P1 Output H 7 22 3 Toggle the Level of a...

Page 101: ... MB NTP Enable enable_ntp Enable Getting NTP from DHCP server ç SET SYS MB NTP NtpServerFromDhcp enable_ntp_dhcp Query the Active NTP Server ç GET SYS MB NTP ActiveNtpServer Set NTP server ç SET SYS MB NTP NtpServer server_address Synchronize with the NTP server ç CALL SYS MB NTP updateTime Query the Last Synchronization ç GET SYS MB RTC LastUpdate Query the Universal Time Coordinated Time UTC ç G...

Page 102: ...SET MANAGEMENT UI VOLUMECONTROL Enabled enabled Set the Volume ç SET MANAGEMENT UI VOLUMECONTROL Volume volume_value Mute the Volume ç SET MANAGEMENT UI VOLUMECONTROL Mute mute_state Volume Control Jog Dial Status Indicators ç GET MANAGEMENT UI VOLUMECONTROL ROTARY RotaryPosition ç GET MANAGEMENT UI VOLUMECONTROL ROTARY ActualStatus ç GET MANAGEMENT UI VOLUMECONTROL ROTARY LongPress ç GET MANAGEME...

Page 103: ...NT NETWORK StaticNetworkMask netmask Query the Gateway Address ç GET MANAGEMENT NETWORK GatewayAddress Change the Gateway Address Static ç SET MANAGEMENT NETWORK StaticGatewayAddress gw_add Apply Network Settings ç CALL MANAGEMENT NETWORK ApplySettings Ethernet Tool Kit Device Filter Based on MAC Address ç SET MANAGEMENT MACFILTER MACaddress loc MAC_ address receive send name LW2 Control Port Bloc...

Page 104: ...ng the Last Recognized Message String ç GET CTRL TCP C loc Rx Querying the Last Recognized Message Hex ç GET CTRL TCP C loc RxHex Clearing the Last Recognized Stored Message ç CALL CTRL TCP C loc clear Querying the Last Recognized Active Message String ç GET CTRL TCP C loc ActiveRx Querying the Last Recognized Active Message Hex ç GET CTRL TCP C loc ActiveRxHex Set the Active Timeout ç SET CTRL TC...

Page 105: ...T RECOGNIZER Rx Querying the Last Recognized Message Hex ç GET MEDIA UART RECOGNIZER RxHex Clearing the Last Recognized Stored Message ç CALL MEDIA UART RECOGNIZER clear Querying the Last Recognized Active Message String ç GET MEDIA UART RECOGNIZER ActiveRx Querying the Last Recognized Active Message Hex ç GET MEDIA UART RECOGNIZER ActiveRxHex Set the Active Timeout ç SET MEDIA UART RECOGNIZER Act...

Page 106: ...lp customers perform firmware upgrades on our products by giving a few tips on how to start and by explaining the features of the Lightware Device Updater v2 LDU2 software The latest software and firmware pack can be downloaded from www lightware com ç Introduction ç Preparation ç Running the Software ç The Upgrading Steps ç If the Upgrade is not successful ...

Page 107: ...package for different devices The package contains all the necessary components binary and other files The release notes is included in the LFP2 file which is displayed in the window where you select the firmware package file in LDU2 8 2 2 LDU2 Installation ATTENTION Minimum system requirement 2 GB RAM The minimum screen resolution is 1600x900 INFO The Windows and the Mac application has the same ...

Page 108: ...reen When the software is started by the shortcut the device discovery screen appears Press the Search for devices button to start finding the Lightware devices If you start the software by double clicking on the LFP2 file the firmware will be loaded Press the Discover devices button all the devices will be listed which are compatible with the selected firmware pack INFO If you press the Choose pa...

Page 109: ...mal operation mode is suspended as the device is switched to bootload mode Signal processing is not performed Do not interrupt the firmware upgrade If any problem occurs reboot the unit and restart the process Keeping the Configuration Settings By default device configuration settings are restored when firmware upgrade is finished If factory reset has been chosen in the parameters window all devic...

Page 110: ...hich device to select press the Identify me button It makes the front panel LEDs blink for 10 seconds The feature helps to find the device physically Step 3 Check the upgrade parameters DIFFERENCE The appearing settings are device dependent and can be different device by device Clicking on the Update Options button special settings will be available like Creating a backup about the configuration R...

Page 111: ... unit reboots with the new firmware Once the firmware upgrade procedure is completed the device is rebooted with the new firmware Shutting down and restarting the device is recommended START UPDATE 8 5 If the Upgrade is not successful Restart the process and try the upgrade again If the device cannot be switched to bootload firmware upgrade mode you can do that manually as written in the User s ma...

Page 112: ...e v1 1 0b3b3 LDC software v2 5 1b5 9 Troubleshooting Usually if the system seems not to transport the signal as expected the best strategy for troubleshooting is to check signal integrity through the whole signal chain starting from source side and moving forward to device end ...

Page 113: ...signed the product to get the information from the most reliable source However the troubleshooting process can be even faster with your help There are certain pieces of information that push us in the right direction to finding the root cause of the problem If we receive most of this information in the first e mail or it is gathered at the time when you call us then there is a pretty high chance ...

Page 114: ... 1 0b3b3 LDC software v2 5 1b5 10 Appendix Tables drawings guides and technical details as follows ç Specifications ç Factory Default Settings ç Cable Wiring Guide ç Button Numbering ç Mechanical Drawings ç Firmware Release Notes ç Hashtag Keyword List ç Further Information ...

Page 115: ... Weight US 433g with the front panel and rotary knob Control Ethernet Connector type RJ45 female connector Ethernet data rate 10 100Base T full duplex with autodetect Power over Ethernet PoE PoE in 1x PoE out 1x RS 232 Connector type 3 pole Phoenix connector Baud rates between 4800 and 115200 baud Data bits 8 or 9 Parity None Odd Even Stop bits 1 1 5 2 Output voltage Low High level 3 15V 15V 3V In...

Page 116: ...ipment type device LightwaredeviceandaDCE D SUB 9 Phoenix LightwaredeviceandaDTE D SUB 9 Phoenix TX RX 1 6 9 5 2 TX data transmit 3 RX data receive 5 Ground TX RX 1 6 9 5 2 TX data receive 3 RX data transmit 5 Ground INFO The RAP B511 series works as a DCE unit according to its pin out 10 4 Button Numbering 1 2 3 6 7 8 9 10 11 4 5 10 5 Mechanical Drawings Dimensions are in mm RAP B511 EU K W S INF...

Page 117: ...e v2 5 1b5 RAP B511 UK K W S INFO All the RAP B511 UK models have the same size 140 80 95 39 3 2 gang UK 8 3 9 3 50 131 120 6 60 3 60 3 77 38 5 40 5 RAP B511 US K W S INFO All the RAP B511 US models have the same size 115 9 115 9 50 8 3 9 3 2 gang US 39 3 95 46 23 23 41 65 41 65 104 7 112 40 5 ...

Page 118: ...gement Protocol feature Modified DeviceLabel property default text to LW_ productname _ serialnum Addedpropertiesinrootnode FirmwareVersion PackageVersion MacAddress Added property to indicate FeaturePackVersion Advanced Control pack v3 Added Condition detect on property change to anything in Event Manager Advanced Control pack v3 Added Network HostName property default lightware serialnum Support...

Page 119: ...onfiguration buttonlock Front panel button lock setting devicelabel Device label dhcp Dynamic IP address DHCP setting eventmanager Event manager factory Factory default settings firmwareversion Firmware version query gpio GPIO realted settings http Http post and put messaging salvo commands infra Infrared port related settings infrared Infrared port related settings Hashtag Keyword Description ipa...

Page 120: ...procedures will not apply to any product that has been 2 1 Modified repaired or altered by anyone other than a certified Lightware engineer unless expressly agreed beforehand 2 2 Used in any application other than that for which it was intended 2 3 Subjected to any mechanical or electrical abuse or accidental damage 2 4 Any costs incurred for repair replacement of goods that fall into the above ca...

Search results

Summary of Contents for RAP-B511-EU

Reviews:

Related manuals for RAP-B511-EU

Brands by name

Popular brands

Lightware RAP-B511-EU, User Manual

Search results

Summary of Contents for RAP-B511-EU

Reviews:

Related manuals for RAP-B511-EU

Brands by name

Popular brands