Sony Kdl-55W800B Device Driver Netlinx Api

Sony
KDL-55W800B
Device Driver
NetLinx API
Sony KDL-55W800B
AMX LLC 2014
Page 1
1. XDD Information
Device Details
Device Type: TV
Manufacturer: Sony
Model(s):
KDL-55W800B
Device Revision: 1.0.0
Support Communication Types: IP
IP Connection Parameters:
Default IP Address: 192.168.0.1
Default IP Port: 20060
File Name: Sony_TV_KDL-55W800B_1.0.0.xdd
Author's Email: tv-sw-b2b-custominstall@jp.sony.com
Default Device Warming Time: 0 seconds
Default Device Cooling Time: 0 seconds
The following are comments provided by the author of the XDD.

MANUFACTURER'S URL (website and/or product manuals)
http://www.sony.net/
CONTROL USAGE
IP Port: 20060
SETUP BRAVIA TV
1. Set up network connections
[Settings] -> [Network] -> [Network Set-up]
2. Enable Simple IP Control
[Settings] -> [Network] -> [Home Network Setup] -> [IP Control] -> [Simple IP Control] -> [On]
Sony KDL-55W800B
AMX LLC 2014
Page 2
2. Channel Information
The following are NetLinx Channels supported by this Device Driver. " * " denotes channels provided by Duet2 base and not protocol provided in
this Device Driver.
Channel
Port
10
11
12
13
14
15
16
17
18
19
21
24
25
Sony KDL-55W800B
Description
Function: Power State
Momentary Function: Cycle power when channel is activated
NetLinx Constant: POWER
Function: Keypad Buttons
Description: Momentary Function: Press menu button DIGIT_0
NetLinx Constant: DIGIT_0
Description: Momentary Function: Press menu button ENTER
NetLinx Constant: MENU_ENTER
Function: Volume
Description: Ramping Function: Volume is ramped up while channel is active
NetLinx Constant: VOL_UP
ON: Increment Volume by 1.
OFF:
Function: Volume
Description: Ramping Function: Volume is ramped down while channel is active
NetLinx Constant: VOL_DN
ON: Decrement Volume by 1.
OFF:
AMX LLC 2014
Page 3
26
27
28
43
44
45
46
47
48
49
50
81
92
101
102
104
113
191
Sony KDL-55W800B
Function: Mute
Momentary Function: Cycle volume mute when channel is activated
NetLinx Constant: VOL_MUTE
Description: Momentary Function: Power is turned on when channel is activated
NetLinx Constant: PWR_ON
Description: Momentary Function: Power is turned off when channel is activated
NetLinx Constant: PWR_OFF
Description: Momentary Function: Press menu button CANCEL
NetLinx Constant: MENU_CANCEL
Function: Main Buttons
Description: Momentary Function: Press menu button MENU_FUNC
NetLinx Constant: MENU_FUNC
Function: Navigation Buttons
Description: Momentary Function: Move menu cursor UP
NetLinx Constant: MENU_UP
Description: Momentary Function: Move menu cursor DOWN
NetLinx Constant: MENU_DN
Description: Momentary Function: Move menu cursor LEFT
NetLinx Constant: MENU_LT
Description: Momentary Function: Move menu cursor RIGHT
NetLinx Constant: MENU_RT
Momentary Function: Select current menu item
NetLinx Constant: MENU_SELECT
Description: Momentary Function: Press menu button EXIT
NetLinx Constant: MENU_EXIT
Description: Momentary Function: Press menu button BACK
NetLinx Constant: MENU_BACK
Description: Momentary Function: Press menu button DOT
NetLinx Constant: MENU_DOT
Function: Settop Box Buttons
Description: Momentary Function: Press menu button INFO
NetLinx Constant: MENU_INFO
Function: Settop Box Buttons
Description: Momentary Function: Press menu button FAVORITES
NetLinx Constant: MENU_FAVORITES
Description: Momentary Function: Press menu button RETURN
NetLinx Constant: MENU_RETURN
Description: Momentary Function: Press menu button HELP
NetLinx Constant: MENU_HELP
Function: Picture In Picture
Momentary Function: Cycle PIP positions when channel is activated
NetLinx Constant: PIP_POS
AMX LLC 2014
Page 4
194
195
196
199
210
211
251*
252*
253*
254*
255*
Sony KDL-55W800B

Momentary Function: Cycle PIP when channel is activated
NetLinx Constant: PIP
Description: Discrete Function: PIP is on while channel is active
NetLinx Constant: PIP_ON
ON: ON
OFF: OFF
Function: Input Source
Momentary Function: Cycle input source when channel is activated
NetLinx Constant: SOURCE_CYCLE
Function: Mute
Description: Discrete Function: Volume mute is on while channel is active
NetLinx Constant: VOL_MUTE_ON
ON: ON
OFF: OFF
Function: Picture Mute
Momentary Function: Cycle picture mute when channel is activated
NetLinx Constant: PIC_MUTE
Function: Picture Mute
Description: Discrete Function: Picture Mute is on while channel is active
NetLinx Constant: PIC_MUTE_ON
ON: ON
OFF: OFF
Description: Communication is established with device while channel is on
NetLinx Constant: MODULE_DEVICEONLINE
ON: Communication online.
OFF: Communication offline.
Description: Module data is synchronized with device while channel is on
NetLinx Constant: MODULE_DATA_INITIALIZED
ON: Data initialized.
OFF: Data not initialized.
Description: Feedback: Indicates Power is starting up and cannot accept commands
NetLinx Constant: POWER_STARTUP_FB
ON: Device warming.
OFF: Device done warming.
Description: Feedback: Indicates Power is shutting down and cannot accept commands
NetLinx Constant: POWER_SHUTDOWN_FB
ON: Device cooling.
OFF: Device done cooling.
Description: Discrete Function: Power is on while channel is active
NetLinx Constant: POWER_ON
ON: Device ON.
OFF: Device OFF.
AMX LLC 2014
Page 5
3. Level Information
The following are NetLinx Levels supported by this Device Driver. All levels support the NetLinx range [0-255].
Level
1
Sony KDL-55W800B
Port
1
Description
Function: Volume
Description: Set volume level
NetLinx Constant: VOL_LVL
Minimum: 0
Maximum: 255
AMX LLC 2014
Page 6
4. Command Information
The following are NetLinx Commands supported by this Device Driver.
Functional
Group
Port
SNAPI2 Command
?COOLDOWN
Power State
Description:
?COOLDOWN Query for shut down time.
Responds with:
COOLDOWN-<time>
Where:
<time> is in seconds
?WARMUP
Power State
Description:
?WARMUP Query for start up time.
Responds with:
WARMUP-<time>
Where:
COOLDOWN
Power State
Description:
COOLDOWN-<seconds> Set shut down time.
Where:
COOLING
Power State
Description:
COOLING-<time> Cooling down counter time.
Where:
<time> is seconds remaining
COUNTERNOTIFY
Power State
Description:
COUNTERNOTIFY-<state> Turn power counter notification on or off.
Where:
<state> is 1 or 0
WARMING
Power State
Description:
WARMING-<time> Warming up counter time, <time> is seconds remaining
WARMUP
Power State
Description:
WARMUP-<seconds> Set warm up time.
Where:
?INPUT
Input Source
Sony KDL-55W800B
Description:
?INPUT Query for the current input.
Responds with:
INPUT-<device label>
Where:
<device label> is one of the values returned in the query ?INPUTLIST.
AMX LLC 2014
Page 7
?INPUTCOUNT
Input Source
Description:
?INPUTCOUNT Query for the number of inputs
?INPUTLISTCOUNT
Input Source
Description:
?INPUTLISTCOUNT Query for the number of input groups.
Responds with:
INPUTLISTCOUNT-<input count>
?INPUTPROPERTIES
Input Source
Description:
?INPUTPROPERTIES Query input properties.
Responds with one INPUTPROPERTY response for each input:
INPUTPROPERTY<index>,<inputGroup>,<signalType>,<deviceLabel>,<displayName>,
Where:
<index> is a virtual input number between 1 and <count>.
<inputGroup> is the integer value of the virtual input port on the device (mutually
exclusive group)
<signalType>
<deviceLabel> is the label on the device
<displayName> is the text shown on the device display.
?INPUTPROPERTY
Input Source
Description:
?INPUTPROPERTY-<index> Query input properties for single input.
Where:
<index> is a virtual input number between 1 and <count>
Responds with:
INPUTPROPERTY-<index>,<inputGroup>,<signalType>,<deviceLabel>,<displayName>
<index> is a virtual input number between 1 and <count>
<inputGroup> is the integer value of the virtual input port on the device (mutually
exclusive group).
<signalType>
<deviceLabel> is the label on the device.
<displayName> is the text shown on the device display.
CYCLESELECT
Input Source
Input Source
Description:
CYCLESELECT Cycles to the next input group.
Responds with:
INPUTSELECT-<index>
INPUT-HDMI1
INPUT-HDMI2
INPUT-HDMI3
INPUT-HDMI4
INPUT-COMPOSITE1
INPUT-COMPOSITE2
INPUT-WIDI
INPUT-TV
Description:
INPUT-<displayName> Set the current input.
LISTSET-<list name>
Device
Sony KDL-55W800B
Description:
LISTSET-<name>,<key>,<value>[;<key>,<value>...] Command to create a PropertyList.
Where:
<name> is the PropertyList name.
<key> is the property key.
<value> is the property value.
LIST APIs are to be used for user defined property list,
these APIs are not intended to be used for well known SNAPI properties.
AMX LLC 2014
Page 8
LISTSELECT-<list name>
Device
Description:
LISTSELECT-<name>,<index> Command to a PropertyList to select the element at index.
Where:
<index> is the one-based decimal ordinal value of a property in the list,
or key name.
LIST APIs are to be used for user defined property list, these APIs are not
intended to be used for well known SNAPI properties.
LISTNEXT-<list name>
Device
Description:
LISTNEXT-<name> Command to iterate in a forward* direction to the
PropertyLists next selected element. *Forward means increasing
ordinal value.
Where:
LIST APIs are to be used for user defined property list, these APIs are not intended to
be used for well known SNAPI properties.
LISTPREV-<list name>
Device
Description:
LISTPREV-<name> Command to iterate in a backward* direction to the
PropertyLists next selected element. *Backward means decreasing
ordinal value.
Where:
LIST APIs are to be used for user defined property list, these APIs are not intended to be
used for well known SNAPI properties.
?LISTSELECT-<list name>
Device
Description:
?LISTSELECT-<name> Query to discover a PropertyLists selected element.
Where:
If <name> is not recognized, no response.
If no selected element,
Responds with:
LISTSELECT-<name>,0
Where:
Otherwise:
Responds with:
LISTSELECT-<name>,<index>,<key>,<value>
Where,
<index> is the one-based decimal ordinal value of this property in the list.
?LISTSIZE-<list name>
Device
Sony KDL-55W800B
Description:
?LISTSIZE-<name> Query to discover a PropertyList size.
Where:
If <name> is not recognized, no response; otherwise,
Responds with:
LISTSIZE-<name>,<size>
Where:
<size> is a decimal integer representing the size of the list.
AMX LLC 2014
Page 9
?LIST-<list name>
Device
Description:
?LIST-<name> Query to discover a PropertyList contents.
Where: <name> is the PropertyList name.
If <name> is not recognized, no response;
otherwise, a series of NetLinx strings, one for each element in the PropertyList.
Responds with:
LIST-<name>,<index>,<key>,<value>
Where:
<name> is the PropertyList name,
<index> is the one-based decimal ordinal value of this property in the list.
?FWVERSION
Device
Description:
?FWVERSION Query for the device firmware version,
Responds with:
FWVERSION-<version>
?VERSION
Device
Description:
?VERSION Query for the module version,
Responds with:
VERSION-<version>
?DRIVERVERSION
Device
Description:
?VERSION Query for the device driver version,
Responds with:
DRIVERVERSION-<version>
(Only valid for Driver Design Modules)
DEBUG-<state>
Device
Description:
DEBUG-<state> Set the debug state.
Where:
<state> is 1-4 for ERROR, WARNING, DEBUG, INFO
?DEBUG
Device
Description:
?DEBUG Query the debug level,
Responds with:
DEBUG-<state>
Where:
<state> is 1-4 for ERROR, WARNING, DEBUG, INFO
REINIT
Device
Description:
REINIT Reinitialize communication with the device
Diagnostic_Mode-<mode>
Device
Description:
NOT FOUND
?PROPERTY-IP_Address
Device
Sony KDL-55W800B
Description:
?PROPERTY-IP_Address
Query the current value of IP address.
AMX LLC 2014
Page 10
PROPERTY-IP_Address,<xxx.xxx.xxx.xxx or hostname>
Device
Description:
PROPERTY-IP_Address,<xxx.xxx.xxx.xxx> or
PROPERTY-IP_Address,<hostname> Set the value of IP address.
Where:
<xxx.xxx.xxx.xxx> is an IP address.
<hostname> is a host name.
REINIT required to take affect.
PROPERTY-Port,<port number>
Device
Description:
PROPERTY-Port,<port number> Set the value of the port number associated with the IP address.
Where:
<port number> is a port number.
?PROPERTY-Port
Device
Description:
?PROPERTY-Port Query the current value of the port number.
Associated with PROPERTY-IP_Address.
PROPERTY-Baud_Rate,<baud rate>
Device
Description:
PROPERTY-Baud_Rate,<baud rate> Where:
<baud rate> is a serial port baud rate.
Set the value of the baud rate associated with the Serial port.
?PROPERTY-Baud_Rate
Device
Description:
?PROPERTY-Baud_Rate Query the current value of the baud rate.
Associated with the Serial port.
?PROPERTY-Device_ID
Device
Description:
?PROPERTY-Device_ID Query the current value of the device id.
If supported by the device this is the id of the end device.
PROPERTY-Device_ID,<device id>
Device
Description:
PROPERTY-Device_ID,<device id> Set the current value of the <device id>.
Where:
<device id> is a new device ID.
If supported by the device this is the id of the end device.
PROPERTY-Poll_Time,<time>
Device
Description:
PROPERTY-Poll_Time,<time> Set the current value of the poll timer interval.
Where:
<time> is expressed in milliseconds.
Warning setting the interval lower than 10,000ms (10 seconds) is not recommended.
REINIT is not required to take affect.
?PROPERTY-Poll_Time
Device
Sony KDL-55W800B
Description:
?PROPERTY-Poll_Time Query the current value of the poll time interval.
AMX LLC 2014
Page 11
PROPERTY-Online_Timeout,<time>
Device
Description:
PROPERTY-Online_Timeout,<time> Set the current value of the online timeout interval.
Where:
<time> is expressed in seconds.
This interval is the maximum time the device will remain in the online state
given that no communication has been received from the device.
?PROPERTY-Online_Timeout
Device
Description:
?PROPERTY-Online_Timeout Query the current value of the online timeout interval.
?PROPERTY-Minimum_Command_Interval
Device
Description:
?PROPERTY-Minimum_Command_Interval Query the current value of the Minimum Time Interval Between Command Messages (in
milliseconds).
This property is read-only.
PASSTHRU-<buffer>
Device
Description:
PASSTHRU-<buffer> SendSend a message directly to the device.
Where:
<buffer> is the data to send
PASSBACK-<state>
Device
Description:
NOT FOUND
PROPERTY-<property name,value>
Device
Description:
PROPERTY-<name>,<value> Set the property to a value.
Where:
<name> is the property name.
?PROPERTY-<property name>
Device
Sony KDL-55W800B
Description:
?PROPERTY-<name>
Query for the value of property.
Responds with:
PROPERTY-<name>,<value>
AMX LLC 2014
Page 12
5. Custom Command Information

No Custom NetLinx Commands supported by this Device Driver.
Sony KDL-55W800B
AMX LLC 2014
Page 13
6. HAS Properties Information

The following NetLinx HAS Properties are supported by this Device Driver.
Port
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
Sony KDL-55W800B
Satisfied
?PROPERTY-Command-Holdoff
?PROPERTY-Has-Aspect-Ratio
?PROPERTY-Has-Aspect-Ratio-Cycle
?PROPERTY-Has-Brightness
?PROPERTY-Has-Color
?PROPERTY-Has-Contrast
?PROPERTY-Has-Filter
?PROPERTY-Has-Freeze
?PROPERTY-Has-Freeze-Cycle
?PROPERTY-Has-Input-Select
?PROPERTY-Has-Input-Select-Cycle
?PROPERTY-Has-Lamp
?PROPERTY-Has-Menu
?PROPERTY-Has-Menu-10Key
?PROPERTY-Has-Menu-Navigate
?PROPERTY-Has-PIP
?PROPERTY-Has-PIP-Cycle
?PROPERTY-Has-PIP-Position-Cycle
?PROPERTY-Has-Picture-Mute
?PROPERTY-Has-Picture-Mute-Cycle
?PROPERTY-Has-Power
?PROPERTY-Has-Power-Cycle
?PROPERTY-Has-Scan
?PROPERTY-Has-Seek
?PROPERTY-Has-Sharpness
?PROPERTY-Has-Station
?PROPERTY-Has-Station-Preset
?PROPERTY-Has-Station-Preset-Group-Cycle
?PROPERTY-Has-Tint
?PROPERTY-Has-Tuner-Band
?PROPERTY-Has-Tuner-Band-Cycle
?PROPERTY-Has-Volume
?PROPERTY-Has-Volume-Mute-Cycle
?PROPERTY-Has-Volume-Ramp
AMX LLC 2014
HAS Property
Query
FALSE
FALSE
FALSE
FALSE
FALSE
FALSE
FALSE
FALSE
FALSE
TRUE
TRUE
FALSE
TRUE
TRUE
TRUE
FALSE
TRUE
TRUE
TRUE
TRUE
TRUE
TRUE
FALSE
FALSE
FALSE
FALSE
FALSE
FALSE
FALSE
FALSE
FALSE
TRUE
TRUE
TRUE
Page 14
7. Properties Information
The following NetLinx Properties are supported by this Device Driver.
Port
Property Query
Value
?PROPERTY-Lamp-Count
?PROPERTY-Menu-List
?PROPERTY-Menu-Navigate-List
1
1
1
1
?PROPERTY-STATIONPRESETCOUNT
?PROPERTY-Scan-List
?PROPERTY-Seek-List
?PROPERTY-Tuner-Band-List
Sony KDL-55W800B
0
BACK
CANCEL
DIGIT_0
DIGIT_1
DIGIT_2
DIGIT_3
DIGIT_4
DIGIT_5
DIGIT_6
DIGIT_7
DIGIT_8
DIGIT_9
DOT
ENTER
EXIT
FAVORITES
HELP
INFO
MENU
RETURN
DOWN
LEFT
RIGHT
UP
0
None Provided.
None Provided.
None Provided.
AMX LLC 2014
Page 15
8. Sample NetLinx Code

The following is sample NetLinx code.
PROGRAM_NAME='Main'
(***********************************************************)
(***********************************************************)
(* System Type : NetLinx
*)
(***********************************************************)
(***********************************************************)
(*
DEVICE NUMBER DEFINITIONS GO BELOW
*)
(***********************************************************)
DEFINE_DEVICE
dvSerialPort = 5001:1:0
dvIpPort = 0:4:0
vdvMyDevice = 41001:1:0
(***********************************************************)
(*
CONSTANT DEFINITIONS GO BELOW
*)
(***********************************************************)
DEFINE_CONSTANT
(***********************************************************)
(*
DATA TYPE DEFINITIONS GO BELOW
*)
(***********************************************************)
DEFINE_TYPE
(***********************************************************)
(*
VARIABLE DEFINITIONS GO BELOW
*)
(***********************************************************)
DEFINE_VARIABLE
CHAR MyXDDFile[] = 'Sony_TV_KDL-55W800B_1.0.0.xdd'
(***********************************************************)
(*
LATCHING DEFINITIONS GO BELOW
*)
(***********************************************************)
DEFINE_LATCHING
(***********************************************************)
(*
MUTUALLY EXCLUSIVE DEFINITIONS GO BELOW
*)
(***********************************************************)
DEFINE_MUTUALLY_EXCLUSIVE
(***********************************************************)
(*
SUBROUTINE/FUNCTION DEFINITIONS GO BELOW
*)
(***********************************************************)
(* EXAMPLE: DEFINE_FUNCTION <RETURN_TYPE> <NAME> (<PARAMETERS>) *)
(* EXAMPLE: DEFINE_CALL '<NAME>' (<PARAMETERS>) *)
(***********************************************************)
(*
STARTUP CODE GOES BELOW
*)
(***********************************************************)
DEFINE_START
DEFINE_MODULE 'DeviceDriverEngine' MyDevice(vdvMyDevice, dvIpPort, MyXDDFile)
(***********************************************************)
(*
THE EVENTS GO BELOW
*)
(***********************************************************)
DEFINE_EVENT
(***********************************************************)
(*
THE ACTUAL PROGRAM GOES BELOW
*)
(***********************************************************)
DEFINE_PROGRAM
(***********************************************************)
(*
END OF PROGRAM
*)
(*
DO NOT PUT ANY CODE BELOW THIS COMMENT
*)
(***********************************************************)
Sony KDL-55W800B
AMX LLC 2014
Page 16
File was created Thu Sep 11 17:15:56 JST 2014

End of Document.
Sony KDL-55W800B
AMX LLC 2014
Page 17

Sony Kdl-55W800B Device Driver Netlinx Api

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Sony Kdl-55W800B Device Driver Netlinx Api

Uploaded by

Copyright:

Available Formats

Sony

AMX LLC 2014

The following are comments provided by the author of the XDD.

AMX LLC 2014

AMX LLC 2014

AMX LLC 2014

Function: Picture In Picture

AMX LLC 2014

AMX LLC 2014

AMX LLC 2014

AMX LLC 2014

AMX LLC 2014

AMX LLC 2014

AMX LLC 2014

AMX LLC 2014

5. Custom Command Information

AMX LLC 2014

6. HAS Properties Information

AMX LLC 2014

AMX LLC 2014

8. Sample NetLinx Code

AMX LLC 2014

File was created Thu Sep 11 17:15:56 JST 2014

AMX LLC 2014

You might also like