controlport

this controlport object is used to configure output levels on the i/o connector and monitor inputs and provides support for the bp200/bp900 usb button boards and gpio ports typically, leds and buttons are attached to the gpio connector on the brightsign player or the brightsign expansion module controlport idl constructor(string port) ] interface controlport { bool setoutputvalue(unsigned param); bool setoutputvalues(unsigned p1, unsigned p2, unsigned p3, unsigned p4); bool setpinvalue(unsigned pin, unsigned param); bool getpinvalue(unsigned pin); bool configureasinput(unsigned pin); bool configureasoutput(unsigned pin); void close() }; object creation to create an controlport object, use the require() method let control port class = require("@brightsign/legacy/controlport") let control port = new control port class("touchboard 0 gpio"); the c ontrolport object is created with a parameter that specifies the port being used ( touchboard 0 gpio in the example above) the port parameter can be one of the following brightsign specifies the onboard gpio connector (including the svc (gpio12) button) expander gpio specifies the db 25 connector on the brightsign expansion module if no brightsign expansion module is attached, then object creation will fail and invalid will be returned expander \<n> gpio specifies a usb to gpio device https //www brightsign biz/digital signage products/accessories/usb c cables connected to the player multiple usb to gpio devices can be controlled using separate rocontrolport instances the first device corresponds to "expander 0 gpio" , the second to "expander 1 gpio" , etc expander dip specifies the eight dip switches on the brightsign expansion module if no brightsign expansion module is attached, then object creation will fail and invalid will be returned note that hot plugging the brightsign expansion module is not supported touchboard \<n> gpio retrieves events from the specified bp200/bp900 button board events are handled in the same manner as events from the brightsign port touchboard \<n> led setup sets various led output options for the specified bp200/bp900 button board touchboard \<n> led sets the bits for each button on the specified bp200/bp900 button board the bits indicate whether the associated led should be on or off since multiple bp200/bp900 button boards can be connected to a player simultaneously, the \<n> value specifies the port enumeration of each board the ordering of multiple attached boards is dependent on the order they appear in the data structure returned by docid\ utkdmpos1ulxaoylx1ns6 an unspecified enumeration value is synonymous with a button board with an enumeration value of 0 (e g touchboard gpio and touchboard 0 gpio are identical) controlport setoutputvalue() bool setoutputvalue(unsigned param) specifies the desired state of all outputs attached to the control port as bits in an integer setoutputvalues() bool setoutputvalues(unsigned p1, unsigned p2, unsigned p3, unsigned p4) configures buttons on a bp200/bp900 button board this method can only be used when the c ontrolport object is instantiated with the touchboard \<n> led setup or touchboard \<n> led parameter see rocontrolport docid 8exdhgmohqig7j uvfce1 for more details the parameters are integer values setpinvalue() bool setpinvalue(unsigned pin, unsigned param) returns a bool and configures either the output of the specified gpio button and the value (either 0 or 1) if the button is not configured as an output, the resulting level is undefined for example, setpinvalue(0,1), setpinvalue(1,1), setpinvalue(2,1), setpinvalue(3,1) etc the led output behavior on rocontrolport docid 8exdhgmohqig7j uvfce1 in this case, the offset is the pin value and the bit mask is the unsigned parameter bool getpinvalue() returns true if the specified input pin is active (low) returns false if the pin is inactive (not connected or high) bool configureasinput() bool configureasinput(unsigned pin) marks the specified button as an input if an invalid button number is passed, false will be returned if successful, the function returns true input buttons are tri stated and can be driven high or low externally bool configureasoutput() bool configureasoutput(unsigned pin) marks the specified button as an output if an invalid button number is passed, false will be returned if successful, the function returns true the output will be driven high or low depending on the current output state of the pin see the hardware interfaces section for your player in the hardware docid\ uyyjyej6qojy1hksbrlpu space for a table of pins and corresponding buttons for the onboard gpio connector close() void close() shuts down the c ontrolport instance events use javascript event handling docid\ surgnnhz666sb1wh6pbd9 to listen for controldown, controlup, and controlevent example this example script sets a bp900 to “twinkle” by turning off each button led at a different point in the cycle const control port class = require('@brightsign/legacy/controlport'); const led = new control port class("touchboard 0 led"); const led setup = new control port class("touchboard 0 led setup"); led setup setpinvalue(0, 0x000b00a0); led setpinvalue(0, 0x07fe); led setpinvalue(1, 0x07fd); led setpinvalue(2, 0x07fb); led setpinvalue(3, 0x07f7); led setpinvalue(4, 0x07ef); led setpinvalue(5, 0x07df); led setpinvalue(6, 0x07bf); led setpinvalue(7, 0x077f); led setpinvalue(8, 0x06ff); led setpinvalue(9, 0x05ff); led setpinvalue(10, 0x03ff);