Documentation > nControl > API Reference
Boom Barrier Tile
nControl™ 2021.0
These tiles control a set of boom barriers.
Introduction
When you click on the tile it opens (setOpen()) or closes (setClosed()) unless you override it by a custom procedure.
Event Scripts
Boom barrier tiles support the following event scripts:
  • Activate tile event: is executed when the tile is activated by switching to simulation of operational mode. This event should be used to initialize the tile.
  • Deactivate tile event: is executed when the tile is deactivated by switching to design of configuration mode.
  • Mouse click event: is executed when the user clicks on the tile.
API Functions
Tile Specific Functions
nBoomBarrierTile.clickTile()
Simulates a mouse click on the tile; this executes the mouse click event script.
nBoomBarrierTile.getState()
Returns the current state of the barriers: nConst.BB_OPEN or nConst.BB_CLOSED.
nBoomBarrierTile.publish(topic, data)
Publishes a message through the internal MQTT broker using the specified topic and data.
nBoomBarrierTile.sendMessage(data)
Sends the ASCII message data to a generic controller, e.g. a Arduino board.
nBoomBarrierTile.setClosed()
Closes the boom barriers.
nBoomBarrierTile.setOpen()
Opens the boom barriers.
Inherited from nTile
nBoomBarrierTile.clearScreen()
Clear all the text in the console window.
nBoomBarrierTile.getTile(label)
Returns the tile object specified by label. If there is no tile with the specified label, the function returns a None value.
nBoomBarrierTile.print(text)
Prints text in the console window. If the console window it not yet visible, printing text will make it visible.
nBoomBarrierTile.showConsole(mode)
Shows (mode = True) or hides (mode = False) the console window.
nBoomBarrierTile.sleep(duration)
Stops the execution of the script for the the given number of seconds. Note that duration can be a floating point number, e.g. to suspend the script for half a seconds use self.sleep(0.5).
nBoomBarrierTile.timestamp()
Returns the number of seconds that passed since nControl™ was launched. It returns a floating point value with the highest possible time resolution supported by your system. The difference between two time stamps provides the number of seconds elapsed between those two events.
nBoomBarrierTile.localVars
Base property to which you can add local variables that retain their value after the event script finishes. For example self.localVars.myVar = 5 adds a new property myVar to self.localVars and gives it the value 5. The localVars property is local to the current tile meaning that each tile has its own independent localVars property.
nBoomBarrierTile.globalVars
Base property to which you can add global variables that retain their value after the event script finishes. For example self.globalVars.myVar = 5 adds a new property myVar to self.globalVars and gives it the value 5. The globalVars property is global to nControl meaning that all tiles use the same globalVars property. As such globalVars can be used to exchange information between the tiles.