AMX NetLinx Studio 2 Manuals

Manuals and User Guides for AMX NetLinx Studio 2. We have 1 AMX NetLinx Studio 2 manual available for free PDF download: Manual

AMX NetLinx Studio 2 Manual (246 pages)

Programming Language

Brand: AMX | Category: Software | Size: 1.53 MB

Table of Contents
3
Introduction

17
- Conventions Used in this Document
  
  17
- Related Instruction Manuals
  
  17
Netlinx Programming Overview

19
- Defining the Superset
  
  19
- Netlinx Vs. Axcess - Comparison by Structure
  
  20
  - Define_Device
    20
  - Define_Constant
    20
  - Define_Variables
    21
  - DEFINE_CALL (Subroutines)
    22
  - Define_Start
    23
  - Define_Event
    23
  - Define_Program
    24
- Operators
  
  24
- Axcess/Netlinx Incompatibility
  
  25
- Data Types
  
  26
- Constants
  
  26
- Variables
  
  27
- Persistent Variables
  
  28
- Arrays
  
  28
- Structures
  
  30
  - Data Sets
    31
- Conditionals & Loops
  
  33
  - Switch
    33
  - FOR Loops
    34
- Functions
  
  35
  - Define_Call
    35
  - Define_Function
    36
- Events
  
  37
  - Button Events
    37
  - Channel Events
    38
  - Data Events
    40
  - Level Events
    43
- Combining Devices, Channels and Levels
  
  44
- String Comparisons
  
  45
  - Axcess Code - String Comparison
    45
  - Netlinx Code - String Comparison
    45
- Modules
  
  45
Language Elements

47
- Statements and Expressions
  
  47
- Assignments
  
  47
  - Variables
    47
  - Output Channels
    47
- Conditionals
  
  48
  - Select
    48
  - If...else
    48
  - Select...active
    48
  - Switch
    49
  - Switch...case
    49
- Loops
  
  50
  - WHILE Statements
    50
  - MEDIUM_WHILE Statements
    50
  - LONG_WHILE Statements
    51
  - FOR Loop Structure
    51
- Waits
  
  52
  - Naming Waits
    52
  - Types of Waits
    52
  - Nesting Waits
    53
  - Pausing and Restarting Waits
    54
  - Canceling Waits
    54
  - Using Waits - Limitations
    54
- Comments
  
  55
- Operators
  
  55
  - Arithmetic Operators
    55
  - Relational Operators
    55
  - Logical Operators
    56
  - Bitwise Operators
    56
  - Assignment Operators
    56
  - Operator Precedence
    57
- Identifiers
  
  57
  - Devices
    57
  - Device Arrays
    58
  - Device Array Examples
    59
  - Device-Channels and Device-Channel Arrays
    59
  - Device-Level Arrays
    60
- Variables
  
  61
  - Scope
    61
  - Local Variables
    61
  - Global Variables
    63
  - Constancy
    64
  - Persistence
    64
- Constants
  
  65
- Data Types
  
  66
  - Intrinsic Types
    66
  - Type Conversion
    66
  - Type Conversion Rules
    66
- Strings
  
  67
  - String Expressions
    67
  - Wide Strings
    67
- Arrays
  
  68
  - Multi-Dimensional Arrays
    69
- Structures
  
  71
- Subroutines
  
  72
  - DEFINE_CALL Subroutines
    72
  - SYSTEM_CALL Subroutines
    72
  - Function Subroutines
    73
  - Calling Parameters
    75
Event Handlers

77
- Button Events
  78
- Channel Events
  79
- Data Events
  80
- Level Events
  81
- Custom Events
  83
- Event Parameters
  84
- Timeline Functions
  
  87
  - Creating a Timeline
    87
  - TIMELINE Example
    90
  - TIMELINE Ids
    94
Combining Devices, Levels, and Channels

95
- Combining and Un-Combining Devices
  
  95
  - Combining Devices
    95
  - Un-Combining Devices
    97
- Combining and Un-Combining Levels
  
  98
  - Combining Levels
    99
  - Un-Combining Levels
    99
- Combining and Un-Combining Channels
  
  100
  - Combining Channels
    100
  - Un-Combining Channels
    100
Master-To-Master (M2M)

107
- Master Routing
  
  108
  - Design Considerations and Constraints
    109
- Control/Netlinx Language Support
  
  111
  - Design Considerations and Constraints
    111
  - General Master-To-Master Issues
    111
Mainline

113
Reserved Identifiers

115
- Compiler Directives
  
  115
  - Define
    115
  - End_If
    115
  - Else
    115
  - If_Defined
    115
  - If_Not_Defined
    115
- Keywords & Run-Time Library Functions
  
  116
  - File
    116
  - Ldate
    116
  - Line
    116
  - Name
    116
  - Time
    116
  - Abs_Value
    116
  - Active
    116
  - Include
    116
  - Warn
    116
  - Add_Url_Entry
    117
  - And (&&)
    117
  - Astro_Clock
    117
  - Atoi
    118
  - Atof
    118
  - Atol
    118
  - Band (&)
    118
  - Bnot (~)
    118
  - Bor (|)
    118
  - Break
    119
  - Button_Event
    119
  - Bxor (^)
    119
  - Call
    119
  - Cancel_All_Wait
    119
  - Cancel_All_Wait_Until
    119
  - Cancel_Wait
    119
  - Cancel_Wait_Until
    120
  - Case
    120
  - Channel_Event
    120
  - Char
    120
  - Chard
    120
  - Chardm
    120
  - Clear_Buffer
    120
  - Clkmgr_Add_Userdefined_Timeserver
    121
  - Clkmgr_Delete_Userdefined_Timeserver
    121
  - Clkmgr_Get_Active_Timeserver
    121
  - Clkmgr_Get_Daylightsavings_Offset
    121
  - Clkmgr_Get_Resync_Period
    121
  - Clkmgr_Get_Start_Daylightsavings_Rule
    121
  - Clkmgr_Get_End_Daylightsavings_Rule
    122
  - Clkmgr_Get_Timeservers
    122
  - Clkmgr_Get_Timezone
    122
  - Clkmgr_Is_Daylightsavings_On
    122
  - Clkmgr_Is_Network_Sourced
    122
  - Clkmgr_Set_Active_Timeserver
    122
  - Clkmgr_Set_Clk_Source
    122
  - Clkmgr_Set_Daylightsavings_Mode
    122
  - Clkmgr_Set_Daylightsavings_Offset
    122
  - Clkmgr_Set_End_Daylightsavings_Rule
    122
  - Clkmgr_Set_Resync_Period
    123
  - Clkmgr_Set_Start_Daylightsavings_Rule
    123
  - Clkmgr_Set_Timezone
    123
  - Clock
    123
  - Combine_Channels
    123
  - Combine_Devices
    124
  - Combine_Levels
    124
  - Command
    124
  - Compare_String
    125
  - Constant
    125
  - Create_Buffer
    125
  - Create_Level
    126
  - Create_Multi_Buffer
    126
  - Data_Event
    127
  - Date
    128
  - Day
    128
  - Date_To_Day
    128
  - Date_To_Month
    128
  - Date_To_Year
    128
  - Day_Of_Week
    128
  - Default
    128
  - Define_Call
    129
  - Define_Combine
    129
  - Define_Connect_Level
    129
  - Define_Constant
    129
  - Define_Device
    130
  - Define_Event
    130
  - Define_Function
    130
  - Define_Latching
    130
  - Define_Module
    130
  - Define_Mutually_Exclusive
    131
  - Define_Program
    131
  - Define_Start
    131
  - Define_Toggling
    131
  - Define_Type
    131
  - Define_Variable
    132
  - Delete_Url_Entry
    132
  - Dev
    132
  - Devchan
    132
  - Device_Id
    132
  - Device_Id_String
    132
  - Device_Info
    133
  - Devlev
    134
  - Do_Push
    135
  - Do_Push_Timed
    135
  - Do_Release
    135
  - Double
    135
  - Duet_Mem_Size_Get
    135
  - Duet_Mem_Size_Set
    135
  - Else
    135
  - False
    135
  - File_Close
    136
  - File_Copy
    136
  - File_Createdir
    137
  - File_Delete
    137
  - File_Dir
    137
  - File_Getdir
    138
  - File_Open
    138
  - File_Read
    139
  - File_Read_Line
    139
  - File_Removedir
    140
  - File_Rename
    140
  - File_Seek
    140
  - File_Setdir
    141
  - File_Write
    141
  - File_Write_Line
    141
  - Find_String
    142
  - First_Local_Port
    142
  - Float
    142
  - For
    142
  - Format
    143
  - Ftoa
    144
  - Get_Buffer_Char
    144
  - Get_Buffer_String
    144
  - Get_Dns_List
    145
  - Get_Ip_Address
    145
  - Get_Last
    146
  - Get_Multi_Buffer_String
    147
  - Get_Pulse_Time
    147
  - Get_Serial_Number
    147
  - Get_System_Number
    147
  - Get_Timer
    147
  - Get_Unique_Id
    147
  - Get_Url_List
    148
  - Hextoi
    149
  - Hold
    150
  - Include
    150
  - Integer
    150
  - Ip_Client_Close
    150
  - Ip_Client_Open
    151
  - Ip_Mc_Server_Open
    152
  - Ip_Server_Close
    152
  - Ip_Server_Open
    153
  - Itoa
    153
  - Itohex
    153
  - Ldate
    153
  - Left_String
    154
  - Length_Array
    154
  - Length_String
    155
  - LENGTH_VARIABLE_TO_STRING (VARIABLE Encode)
    155
  - Length_Variable_To_Xml
    155
  - Level_Event
    155
  - Local_Var
    155
  - Long
    155
  - Long_While
    156
  - Lower_String
    156
  - Lshift
    156
  - Master_Sn
    156
  - Master_Slot
    156
  - Max_Value
    156
  - Max_Length_Array
    156
  - Max_Length_String
    157
  - Medium_While
    157
  - Mid_String
    157
  - Min_Value
    157
  - Min_To
    157
  - Mod (%)
    158
  - Module_Name
    158
  - Not (!)
    158
  - Non_Volatile
    158
  - Off
    158
  - Offline
    158
  - Onerror
    158
  - Online
    158
  - Pause_All_Wait
    158
  - Pause_Wait
    158
  - Persistent
    159
  - Program_Name
    159
  - Pulse
    159
  - Push
    159
  - Push_Channel
    159
  - Push_Devchan
    159
  - Push_Device
    159
  - Random_Number
    159
  - Raw_Be
    159
  - Raw_Le
    159
  - Reboot
    160
  - Rebuild_Event()
    160
  - Redirect_String
    162
  - Release
    162
  - Release_Channel
    162
  - Release_Devchan
    162
  - Release_Device
    162
  - Remove_String
    163
  - Repeat
    163
  - Restart_All_Wait
    163
  - Restart_Wait
    163
  - Return
    163
  - Right_String
    163
  - Rshift
    164
  - Select
    164
  - Send_Command
    164
  - Send_Level
    164
  - Send_String
    164
  - Set_Dns_List
    165
  - Set_Ip_Address
    165
  - Set_Length_Array
    166
  - Set_Length_String
    166
  - Set_Outdoor_Temperature
    166
  - Set_Pulse_Time
    166
  - Set_System_Number
    167
  - Set_Timer
    167
  - Set_Virtual_Channel_Count
    167
  - Set_Virtual_Level_Count
    167
  - Set_Virtual_Port_Count
    167
  - Sinteger
    167
  - Slong
    167
  - Stack_Var
    168
  - String
    168
  - String_To_Variable (Variable Decode)
    168
  - Structure
    168
  - Switch
    169
  - System_Call
    169
  - System_Number
    169
  - Time
    169
  - Time_To_Hour
    169
  - Time_To_Minute
    169
  - Time_To_Second
    170
  - Timed_Wait_Until
    170
  - Timeline_Active
    170
  - Timeline_Create
    170
  - Timeline_Event
    171
  - Timeline_Get
    171
  - Timeline_Kill
    171
  - Timeline_Pause
    171
  - Timeline_Reload
    172
  - Timeline_Restart
    172
  - Timeline_Set
    172
  - Total_Off
    173
  - True
    173
  - Type_Cast
    173
  - Uncombine_Channels
    173
    
    Uncombine_Devices
    173
    
    Uncombine_Levels
    174
    
    Upper_String
    174
    
    Variable_To_String (Variable Encode)
    174
    
    Variable_To_Xml
    175
    
    Volatile
    177
    
    Wait
    177
    
    Wait_Until
    177
    
    While
    177
    
    Widechar
    177
    
    Xml_To_Variable
    178
- Send_Commands
  
  180
  - DEFINE_MUTUALLY_EXCLUSIVE and Variables
    180
  - Xor (^^)
    180
Compiler Messages

183
- Compiler Warnings
  
  183
  - (W) Cannot Assign Unlike Types
    183
  - (W) Define_Call Is Not Used
    183
  - (W) Integer Applies to Arrays Only
    183
  - (W) Long_While Within While
    183
  - (W) Possibly too Many Nested Levels
    183
  - (W) Variable Is Not Used
    184
- Compiler Errors
  
  184
  - A "<Symbol>" was Expected
    184
  - ACTIVE Keyword Expected
    184
  - Allowed Only in DEFINE_START
    184
  - Attempted CALL to Undefined Subroutine
    184
  - Comment Never Ends, EOF Encountered
    184
  - Conditional Compile Nesting too Deep
    184
  - Constant Type Not Allowed
    184
  - DEFINE_CALL Must Have a Name
    184
  - Evaluation Stack Overflow
    185
  - Evaluation Stack Underflow
    185
  - Identifier Expected
    185
  - Identifier Is Not an Array Type
    185
  - Include File Not Found
    185
  - Invalid Include File Name
    185
  - Library File Not Found
    185
  - Maximum String Length Exceeded
    185
  - Must be Char Array Reference
    185
  - Must be Integer Reference
    185
  - PUSH_CHANNEL Not Allowed Within Wait
    186
  - RELEASE_CHANNEL Not Allowed Within Wait
    186
  - PUSH_DEVICE Not Allowed Within Wait
    186
  - RELEASE_DEVICE Not Allowed Within Wait
    186
  - String Constant Expected
    186
  - String Constant Never Ends, EOF Encountered
    186
  - String Literal Expected
    186
  - Subroutine May Not Call Itself
    186
  - Syntax Error
    186
  - This Variable Type Not Allowed
    186
  - Too few Parameters in CALL
    187
  - Too Many Include Files
    187
  - Too Many Parameters in CALL
    187
  - Type Mismatch in Function CALL
    187
  - Undefined Identifier
    187
  - Unmatched #END_IF
    187
  - Unrecognized Character in Input File
    187
  - Use SYSTEM_CALL [Instance] 'Name
    187
  - Variable Assignment Not Allowed here
    187
  - Wait Not Found
    187
  - Bad Assign Call
    188
  - Bad Element Assign
    188
  - Bad Off... Bad On... Bad to
    188
  - Bad Re-Assign Call
    188
  - Bad Run Token
    188
  - Bad Set_Length
    188
  - Bad While
    188
Netlinx Unicode Functions

189
- Overview
  
  189
  - Ch_To_Wc
    189
  - Wc_Compare_String
    189
  - Wc_Concat_String
    189
  - Wc_Decode
    190
  - Wc_Encode
    190
  - Wc_File_Close
    191
  - Wc_File_Open
    192
  - Wc_File_Read
    193
  - Wc_File_Read_Line
    193
  - Wc_File_Write
    194
  - Wc_File_Write_Line
    194
  - Wc_Find_String
    194
  - Wc_Get_Buffer_Char
    195
  - Wc_Get_Buffer_String
    195
  - Wc_Left_String
    195
  - Wc_Length_String
    195
  - Wc_Lower_String
    196
  - Wc_Max_Length_String
    196
  - Wc_Mid_String
    196
  - Wc_Remove_String
    196
  - Wc_Right_String
    197
  - Wc_Set_Length_String
    197
  - Wc_To_Ch
    197
  - Wc_Tp_Encode
    197
  - Wc_Upper_String
    197
- Working with Unicode in Netlinx Studio V2.4
  
  198
  - Configuring Netlinx Studio
    198
  - Including the Unicode Library
    199
  - Defining a Unicode String Literal
    199
  - Storing a Unicode String
    200
  - Working with WIDECHAR Arrays and Unicode Strings
    200
  - Character Case Mappings
    201
  - Concatenating String
    201
  - Converting between WIDECHAR and CHAR
    201
  - Using FORMAT
    201
  - Right-To-Left Unicode Strings
    202
  - Reading and Writing to Files
    202
  - Send Strings to a User Interface
    202
  - Compiler Errors
    203
IP Communication

205
- Client Programming
  
  205
  - Initiating a Conversation
    205
  - Terminating a Conversation
    206
  - Sending Data
    206
  - Receiving Data
    206
- Server Programming
  
  207
  - Listening for Client Requests
    207
  - Multiple Client Connections
    208
  - Closing a Local Port
    208
  - Connection-Oriented Notifications
    208
  - Receiving Data
    209
  - Sending Data
    209
  - Receiving Data with UDP
    209
  - Multicast
    210
  - Example IP Code
    210
Netlinx Modules

213
- Defining a Module
  213
- Using a Module in a Program
  220
Internet Inside

223
- Java Tpclasses
  223
- WDM Configuration
  224
Encoding and Decoding: Binary and XML

225
Appendix A: Marshalling Protocol

231
- Marshalled Stream Format
  231
- Marshalling Protocol (Group of Bytes)
  
  233
- Marshalling Protocol (Variables)
  
  233
  - Marshalled Stream Format
    233
  - Encoding Notes
    235
  - String Encoding
    235
  - Binary Array Encoding
    235
  - Binary Encoding Result
    237
  - XML Encoding Result
    239
Appendix B: Glossary

241

AMX Categories

Touch Panel Matrix Switcher Controller

Switch Keypad

More AMX Manuals

AMX NetLinx Studio 2 Manuals

AMX NetLinx Studio 2 Manual (246 pages)

Table of Contents

Introduction

Conventions Used in this Document

Related Instruction Manuals

Netlinx Programming Overview

Defining the Superset

Netlinx Vs. Axcess - Comparison by Structure

Operators

Axcess/Netlinx Incompatibility

Data Types

Constants

Variables

Persistent Variables

Arrays

Structures

Conditionals & Loops

Functions

Events

Combining Devices, Channels and Levels

String Comparisons

Modules

Language Elements

Statements and Expressions

Assignments

Conditionals

Loops

Waits

Comments

Operators

Identifiers

Variables

Constants

Data Types

Strings

Arrays

Structures

Subroutines

Event Handlers

Timeline Functions

Combining Devices, Levels, and Channels

Combining and Un-Combining Devices

Combining and Un-Combining Levels

Combining and Un-Combining Channels

Master-To-Master (M2M)

Master Routing

Control/Netlinx Language Support

Mainline

Reserved Identifiers

Compiler Directives

Keywords & Run-Time Library Functions

Send_Commands

Compiler Messages

Compiler Warnings

Compiler Errors

Netlinx Unicode Functions

Overview

Working with Unicode in Netlinx Studio V2.4

IP Communication

Client Programming

Server Programming

Netlinx Modules

Internet Inside

Encoding and Decoding: Binary and XML

Appendix A: Marshalling Protocol

Marshalling Protocol (Group of Bytes)

Marshalling Protocol (Variables)

Appendix B: Glossary

Related Products

AMX Categories