ADDERLink INFINITY Manager Manual

							60
INSTALLATION
CONFIGURATION
OPERATION
FURTHERINFORMATION
INDEX
get_presets
This method was last updated in API version 1, and is compatible with API requests from 
version 1 onwards
This simple function returns a list of presets available to the authenticated user.
Input parameters:
- token
- v (the A.I.M. API version this request is designed for)
- results_per_page (number of results per page, default = 1000)
- page (page number to start showing results for, default = 1)
Output values:
- version - the current API version number
- timestamp - the current server time
- success
- page (page number)
- results_per_page (number of results per page, default = unlimited)
- total_presets - the total number of presets available to the authenticaed user
- count_presets - the number of presets on this page, available to the authenticated user
- for each connection_preset:
   - attribute: item (e.g. 17th preset)
   - cp_id (preset id)
 - cp_name (preset name)
 - cp_description (preset description)
 - cp_pairs (the number of channel-receiver pairs in this preset)
   - problem_cp_pairs (the number of channel-receiver pairs that are  
 mis-configured
     (e.g. receiver offline, receiver not defined)
   - cp_active (whether all, any, or none of the channel-receiver pairs in this preset are    
 currently connected; values are ‘full’, ‘partial’, and ‘none’)
   - connected_rx_count (the number of receivers in this preset that are already    
 connected)
   - view_button (disabled/enabled/hidden - whether the user can connect to the    
 preset in view-only mode.
     disabled = no, because something is in use by someone else.  
 hidden = never. enabled = yes)
   - shared_button (disabled/enabled/hidden - as above, but in shared mode)
   - exclusive_button (disabled/enabled/hidden - as above, but in exclusive mode)
Examples
Input:
/api/?v=1&method=get_presets&token=xxxxx
Output:

   1
   2012-12-14 12:12:12
   1
   1
   10
   2
   2
   
      3
      Preset 1
      Description for Preset 1
      1
      
      full
      1
      disabled
      disabled
      disabled
   
   
      4
      Preset 2
      Description for Preset 2
      2
      
      none
      
      enabled
      hidden
      hidden
   
   
						

							61
INSTALLATION
CONFIGURATION
OPERATION
FURTHERINFORMATION
INDEX
connect_channel
This method was last updated in API version 2, and is compatible with API requests from 
version 2 onwards
This simple function connects a receiver to a channel.
Input parameters:
- token
- v (the A.I.M. API version this request is designed for)
- c_id - the ID of the channel (acquired from get_channels)
- rx_id - the ID of the receiver (acquired from get_receivers)
- view_only (optional, 0/1 - defaults to 0)
- exclusive (optional, 0/1 - defaults to 0)
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (optional, if anything went wrong with connecting the channel)
Examples
Input:
/api/?v=2&method=connect_channel&token=xxxxx&c_id=1&rx_id=2&exclusive=1
Output:

   2
   2012-12-12 12:12:12
   1

or

   2
   2012-12-12 12:12:12
   0
   
      
         231
         ERROR - exclusive connection not available
      
   

connect_preset
This method was last updated in API version 1, and is compatible with API requests from 
version 1 onwards
This simple function connects all channel-receiver pairs in a preset.
Input parameters:
- token
- v (the A.I.M. API version this request is designed for)
- id - the ID of the preset (acquired from get_presets)
- view_only (optional, 0/1 - defaults to 0)
- exclusive (optional, 0/1 - defaults to 0)
- force (optional, 0/1 - defaults to 0) - whether to ignore errors with some of the preset’s      
pairs or not
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (optional, if anything went wrong with connecting the presets)
Examples
Input:
/api/?v=1&method=connect_preset&token=xxxxx&id=1&force=1
Output:

   1
   2012-12-12 12:12:12
   1

or

   1
   2012-12-12 12:12:12
   0
   
      
         210
         ”.$config[‘error_codes’][210].”
      
   
   
						

							62
INSTALLATION
CONFIGURATION
OPERATION
FURTHERINFORMATION
INDEX
disconnect_channel
This method was last updated in API version 2, and is compatible with API requests from 
version 2 onwards
This function disconnects a receiver, a number of receivers, or all connected receivers.
Input parameters:
- token
- v (the A.I.M. API version this request is designed for)
- rx_id (ID(s) of the receiver, as an integer, or comma-separated set of integers. Optional. 
If not supplied, all connections will be ended)
- force - whether to disconnect existing connections by other users, or for offline 
receivers
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (if anything failed, details are returned here)
Examples
Input:
/api/?v=2&method=disconnect_channel&token=xxxxx&rx_id=1
/api/?v=2&method=disconnect_channel&token=xxxxx&rx_id=1,2,3
/api/?v=2&method=disconnect_channel&token=xxxxx&force=1
Output:

   2
   2012-12-12 12:12:12
   1

disconnect_preset
This method was last updated in API version 1, and is compatible with API requests from 
version 1 onwards
This function disconnects all channel-receiver pairs in a preset, or disconnects ALL 
connections in the whole A.I.M. network.
Input parameters:
- token
- v (the A.I.M. API version this request is designed for)
- id (optional. If not supplied, all connections will be ended)
- force - whether to ignore errors with some of the preset’s pairs or not
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (if anything failed, details are returned here)
Examples
Input:
/api/?v=1&method=disconnect_preset&token=xxxxx&id=1&force=1
Output:

   1
   2012-12-12 12:12:12
   1
   
						

							63
INSTALLATION
CONFIGURATION
OPERATION
FURTHERINFORMATION
INDEX
create_preset
This method was last updated in API version 3, and is compatible with API requests from 
version 3 onwards
This function creates a new preset. The API user must have admin privileges to call this 
method successfully.
Input parameters:
- token
- v (the A.I.M. API version this request is designed for)
- name (the display name for the new preset)
- pairs (a comma-separated list of the channel ID–receiver ID pairs for the preset, where   
 each ID in the pair is separated by a hyphen)
- allowed (the permitted connection modes for the preset. Optional; if omitted, the    
 global setting will be inherited. Permitted values are:
      v   - view only
      vs  - view and shared only
      s   - shared only
      e   - exclusive only
      vse - any mode allowed)
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (if anything failed, details are returned here)
- id (the ID of the new preset, if it was created)
Examples
Input:
/api/?v=3&method=create_preset&token=xxxxx&name=my_preset&pairs=1-1,1-2,2-3,2-
4&allowed=vs
Output:

   3
   2012-12-12 12:12:12
   1
   5

delete_preset
This method was last updated in API version 3, and is compatible with API requests from 
version 3 onwards
This function deletes a preset. The API user must have admin privileges to call this 
method successfully.
Input parameters:
- token
- v (the A.I.M. API version this request is designed for)
- id (the ID of the preset to be deleted)
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (if anything failed, details are returned here)
Examples
Input:
/api/?v=3&method=delete_preset&token=xxxxx&id=5
Output:

   3
   2012-12-12 12:12:12
   1
   
						

							64
INSTALLATION
CONFIGURATION
OPERATION
FURTHERINFORMATION
INDEX
SAFETY INFORMATION
• For use in dry, oil free indoor environments only.
• Warning - live parts contained within power adapter.
• No user serviceable parts within power adapter - do not dismantle.
• Plug the power adapter into a socket outlet close to the module that it is powering.
• Replace the power adapter with a manufacturer approved type only. 
• Do not use the power adapter if the power adapter case becomes damaged, cracked 
or broken or if you suspect that it is not operating properly.
• Do not attempt to service the unit yourself.
• Not suitable for use in hazardous or explosive environments or next to highly 
flammable materials.
• Do not use the power adapter if the power adapter case becomes damaged, cracked 
or broken or if you suspect that it is not operating properly.
• If you use a power extension cable, make sure the total ampere rating of the devices 
plugged into the extension cable do not exceed the cable’s ampere rating. Also, make 
sure that the total ampere rating of all the devices plugged into the wall outlet does 
not exceed the wall outlet’s ampere rating.
• The power adapter can get warm in operation – do not situate it in an enclosed space 
without any ventilation. 
LITHIUM BATTERY
CAUTION: This product contains a lithium battery which must be disposed 
of in the correct manner.
CAUTION: RISK OF EXPLOSION IF BATTERY IS REPLACED BY AN 
INCORRECT TYPE.
• If the lithium battery needs to be changed, you must return the product to your 
nearest Adder dealer. The battery must be replaced by an authorized Adder dealer. 
• Once the product has come to the end of its useful life, the lithium battery must be 
removed as part of the decommissioning process and recycled in strict accordance 
with the regulations stipulated by your local authority. Advice on battery removal can 
be provided on request by Adder. 
WARRANTY
Adder Technology Ltd warrants that this product shall be free from defects in 
workmanship and materials for a period of two years from the date of original purchase. 
If the product should fail to operate correctly in normal use during the warranty period, 
Adder will replace or repair it free of charge. No liability can be accepted for damage due 
to misuse or circumstances outside Adder’s control. Also Adder will not be responsible 
for any loss, damage or injury arising directly or indirectly from the use of this product. 
Adder’s total liability under the terms of this warranty shall in all circumstances be 
limited to the replacement value of this product.
If any difficulty is experienced in the installation or use of this product that you are 
unable to resolve, please contact your supplier.   
						

							65
INSTALLATION
CONFIGURATION
OPERATION
FURTHERINFORMATION
INDEX
RADIO FREQUENCY ENERGY
All interface cables used with this equipment must be shielded in order to maintain 
compliance with radio frequency energy emission regulations and ensure a suitably high 
level of immunity to electromagnetic disturbances.
European EMC directive 2004/108/EC
This equipment has been tested and found to comply with the limits for a class A 
computing device in accordance with the specifications in the European standard 
EN55022. These limits are designed to provide reasonable protection against harmful 
interference. This equipment generates, uses and can radiate radio frequency energy 
and if not installed and used in accordance with the instructions may cause harmful 
interference to radio or television reception. However, there is no guarantee that 
harmful interference will not occur in a particular installation. If this equipment does 
cause interference to radio or television reception, which can be determined by turning 
the equipment on and off, the user is encouraged to correct the interference with one 
or more of the following measures: (a) Reorient or relocate the receiving antenna. 
(b) Increase the separation between the equipment and the receiver. (c) Connect 
the equipment to an outlet on a circuit different from that to which the receiver is 
connected. (d) Consult the supplier or an experienced radio/TV technician for help. 
FCC Compliance Statement (United States)
This equipment generates, uses and can radiate radio frequency energy and if not 
installed and used properly, that is, in strict accordance with the manufacturer’s 
instructions, may cause interference to radio communication. It has been tested and 
found to comply with the limits for a class A computing device in accordance with 
the specifications in Subpart J of part 15 of FCC rules, which are designed to provide 
reasonable protection against such interference when the equipment is operated in a 
commercial environment. Operation of this equipment in a residential area may cause 
interference, in which case the user at his own expense will be required to take whatever 
measures may be necessary to correct the interference. Changes or modifications not 
expressly approved by the manufacturer could void the user’s authority to operate the 
equipment.
Canadian Department of Communications RFI statement
This equipment does not exceed the class A limits for radio noise emissions from digital 
apparatus set out in the radio interference regulations of the Canadian Department of 
Communications.
Le présent appareil numérique n’émet pas de bruits radioélectriques dépassant les limites 
applicables aux appareils numériques de la classe A prescrites dans le règlement sur le 
brouillage radioélectriques publié par le ministère des Communications du Canada.   
						

							66
INSTALLATION
CONFIGURATION
OPERATION
FURTHERINFORMATION
INDEX
www.ctxd.com Documentation by:
© 2015 Adder Technology Limited
All trademarks are acknowledged.
Part No. MAN-A.I.M. • Release 3.4
Web:  www.adder.com
Contact:  www.adder.com/contact-details
Support: forum.adder.com   
						

							67
INSTALLATION
CONFIGURATION
OPERATION
FURTHERINFORMATION
INDEX
HT
A
Active Directory  7,38
AFZ  4
Anti-dither support  4
B
Base DN  19
Browsers
supported  11
C
Cable spec
null modem  47
Channel
add channel group  26
configure channel group  26
Channels
add a channel  25
configure a channel  25
view channels page  24
what are they?  6
Channels tab  24
CODEC  4
Connections
transmitter - power in  9
D
Dashboard
active connections page  22
backups page  20
connection log page  22
event log page  23
home page  14
settings page  15
updates page  21
Dashboard tab  14
Distinguished Name  19
Dithering  4
F
Factory reset  12
Favorites  42
Frame Skipping  32
G
Groups
what are they?  6
H
Hotkey settings  17
Hotkey shortcuts  42
I
IP port
connecting  9
L
LDAP  19
Logging in
administrators  11
normal users  42
M
Magic Eye  4
O
On-Screen Display  6,42,43,44
OSD  6
login  42
main screen  43
remote  44
shortcuts  42
P
Permissions  7
Portfast  53
Presets  39
add presets page  40
configure presets page  40
Presets tab  39
R
Receivers
add receiver group page  30
configure group page  30
configure receiver page  28
view receivers page  27
Receivers tab  27
Redundant servers
setting up  50
Regular user  6
Relationship
three-way  6
Remote OSD  44
Reset
manual  12
S
Safety information  64
Search filters  24
Security  6
Server redundancy  50
Servers tab  34
Shortcuts  42
Statistics tab  41
Swapping an AIM server  50
Index
T
TLS  4
Transmitters
configure transmitter page  32
update firmware  32
view transmitters page  31
Transmitters tab  31
Transport Layer Security  4
Troubleshooting  45
U
Users
active directory  38
add user group page  37
add user page  36
configure group page  37
configure user page  36
view users page  35
Users tab  35
Z
Zero-config addresses  13