TOA | AM-CF1W 3CU/H/W | manual | TOA AM-CF1W 3CU/H/W User manual

TOA AM-CF1W 3CU/H/W User manual
AM-CF1
AM-CF1
External Control Protocol - TCP/IP
Ver.1.0.9 2019/7/22
■ Overview
The protocols disclosed in this document are prepared to control AM-CF1 via third-party controllers or via a
computer based terminal application and obtain device information for further integrations.
It is required to log in by password authentication for starting controls and log off when finishing controls.
Log-in
Log-off
The following settings can be controlled.
Speaker output gain
Mute mode
Standby mode
Recalling memory presets
Microphone beam steering
Status notification
Microphone beam steering status notification
The following commands can also be used to get the AM-CF1 setting values.
Status request
Gain value
Mute mode
Standby mode
Preset number
Microphone beam steering setting
Microphone beam steering position
Status information
Microphone beam steering position information (Real-time status of AM-CF1)
TOA Corporation
1/15
AM-CF1
■ Introduction
The external control port of AM-CF1 needs to be set before connecting to the unit by using this protocol.
・Target port
TCP port number: Set the port number according to the remote controller to be connected.
Default value: 3000
■ TCP/IP Communication Specification
#
Item
1 Communication path
2 Message length
3 Message code type
4 Confirmation of delivery
5 Retransmission control
6 Priority control
Contents (implementation rules)
One pathway
Variable length max. 1024 bytes
Binary
If a handshake is performed at the application layer and there is no
response from the AM-CF1 for 1 sec, it is preferable to design the
communication timeout
None
None
・
Define AM-CF1 as the TCP server.
・
TCP port is always connected (keeps alive).
・
To maintain the connection, AM-CF1 performs the following operations.
・
Send some data at least once in 10 seconds. If there is a status to be sent as data, the content is
transmitted otherwise just send 0xFF by 1 byte.
・
If nothing is received from the remote controller for one minute, the TCP/IP connection shall be
automatically terminated.
■ Command Configuration
Command
Data length (N)
Data 1
Data 2
・・・・
Data N
Commands are 80H to FFH, data length is 00H to 7F, and data is 00H to FFH
Data length (N) is included information representing the data length following the data
When a data which is longer than the data length is received, the subsequent data is discarded.
If a data is shorter than the data length and the next command is received, the previous command is
discarded.
When a TCP/IP communication is disconnected, it enables reconnection.
(except for abnormal termination)
TOA Corporation
2/15
AM-CF1
Control Commands and Setting Value
Log-in
Control commands are accepted only when the log-in information matches the password authentication
information in the web browser. If they do not match, AM-CF1 returns a login NACK response as a
command (except log-in and log-off) to the controller. If the controller tries to send a command while the
log-in information of the device is being changed, NACK response is returned. If the communication with
the controller is disconnected, the system will be logged off and the controller needs to log in again.
Once the AM-CF1 receives this command, it responds the password authentication result.
80H, 20H, <User Name>, <Password>
<User Name>
Specifies 16-byte ASCII codes
If the value is less than 16 bytes, the missing value is filled with the NULL character (0x00).
<Password>
Specifies 16-byte ASCII codes
If the value is less than 16 bytes, the missing value is filled with the NULL character (0x00).
The response is generated according to the password authentication result.
ACK response when matched:
80H, 01H, 01H
NACK response when not matched:
80H, 01H, 00H
(e.g.) If User Name is admin and Password is admin (=default setting)
80H, 20H, 61H, 64H, 6DH, 69H, 6EH, 00H, 00H, 00H, 00H, 00H, 00H, 00H, 00H, 00H, 00H, 00H, 61H,
64H, 6DH, 69H, 6EH, 00H, 00H, 00H, 00H, 00H, 00H, 00H, 00H, 00H, 00H, 00H
Log-off
Turn the unit from login status to log-off status
Once the AM-CF1 receives this command, it turns the unit into log-off status and responds the operation
result.
81H, 00H
TOA Corporation
3/15
AM-CF1
Speaker output gain setting (absolute position)
Set the gain level of the speaker output by absolute position.
Please refer to the “Gain Table” chart to check the absolute positions corresponding to gain values (dB).
Once the AM-CF1 receives this command, it changes the gain level and responds the changed final value.
91H, 03H, <Channel Attribute>, <Channel Number>, <Position>
<Channel Attribute>
01H: Speaker Out channel (fixed value)
<Channel Number>
00H: Channel Attribute (fixed value)
* Channel Attribute 00H updates web gain settings
<Position>
00H to 3FH (-∞ to 0dB, Please refer to “Gain Table” chart)
(e.g.) Set the speaker output gain of the unit to 0dB
91H, 03H, 01H, 00H, 3DH
Speaker output gain setting (step)
Set the gain level of the speaker output by position steps.
The gain position can be step up or down from the current position.
Each step changes one position.
Once the AM-CF1 received this command, it changes the gain position and responds the changed position
value.
91H, 03H, <Channel Attribute>, <Channel Number>, <Step>
<Channel Attribute>
01H: Speaker Out channel (fixed value)
<Channel Number>
00H: Channel Attribute (fixed value)
* Channel Attribute 00H updates web gain settings
<Step>
UP: 41H to 5FH (1 step up to 31 step up, (e.g.) 1step up = 41H)
Down: 61H to 7FH (1 step down to 31 step down, (e.g.) 1step down = 61H)
*The minimum value (position) for step down shall be 01H.
(e.g.) Increase the speaker output gain level by 3 steps
91H, 03H, 00H, 00H, 43H
TOA Corporation
4/15
AM-CF1
Mute mode setting
Set the mute mode of the audio input and output channels.
Once the AM-CF1 receives this command, it changes the mute mode and responds the changed final
value.
98H, 03H, <Channel Attribute>, <Channel Number>, <ON/OFF>
<Channel Attribute>
00H: Mic In channel
01H: Speaker Out channel
<Channel Number>
00H: Channel Attribute (fixed value)
<ON/OFF>
00H: Mute mode OFF (unmuted)
01H: Mute mode ON (muted)
(e.g.) Set the microphone mute mode of the unit to ON
98H, 03H, 00H, 00H, 01H
Recalling memory presets
Recall a pre-stored memory preset.
Once the AM-CF1 receives this command, it recalls a pre-stored memory preset and responds the
changed preset number.
F1H, 02H, 00H, <Preset Number>
<Preset Number>
00H to 01H: Preset Number 1 to 2
(e.g.) Recall preset 1
F1H, 02H, 00H, 00H
*Since recalling memory preset requires a certain processing time, it is necessary to adjust the response
wait time.
Standby mode setting
Set the standby mode of the unit.
Once the AM-CF1 receives this command, it changes the unit standby mode and responds the changed
mode status.
F3H, 02H, 00H, <Standby mode>
<Standby mode>
00H: Standby mode OFF
01H: Standby mode ON
(e.g.) Turn the unit into standby mode
F3H, 02H, 00H, 01H
TOA Corporation
5/15
AM-CF1
Microphone beam steering setting
Set the microphone beam steering setting parameters. When the unit is set as Manual mode, the direction
of the sound source is specified by Direction and the distance of the sound source is specified by Distance.
A0H, 05H, <Auto/Manual>,<Direction>,<Distance>,<inch/cm>
<Auto/Manual>
00H: Auto
01H: Manual
<Direction>
Signed 1-byte integer
For Manual: -90 to 90 [deg]
For Auto: 0
<Distance>
An unsigned two-byte integer expressed in big-endian decimal places.
For Manual:
<inch/cm> For inch: 0 to 2400 [inch per 10] (0.0 to 240.0 [inch])
<inch/cm> For cm: 0 to 6000 [cm per 10] (0.0 to 600.0 [cm])
For Auto: 0
<inch/cm>
Only Manual is used. (Setup application only)
00H: inch
01H: cm
(e.g.) Set Auto
A0H, 05H, 00H, 00H, 00H, 00H, 00H
(e.g.) In the Manual mode, set the Direction at -90, the Distance at 240.0, and the unit of length as inch.
A0H, 05H, 01H, A6H, 09H, 60H, 00H
TOA Corporation
6/15
AM-CF1
Status notification setting
Turn on or off the status notification function of the AM-CF1. The status notification is not performed when
it is being logged off.
*The default value is OFF.
F2H, 02H, 00H, <ON/OFF>
<ON/OFF>
00H: OFF (Status notification is disabled)
01H: ON (Status notification is enabled)
Microphone beam steering status notification setting
Turn on or off the microphone beam steering status notification function of the AM-CF1. The status
notification is not performed when it is being logged off. Once the setting is ON, the microphone’s beam
steering position is notified by X and Y coordinate values with the specified unit of length at the set interval.
Unlike status notification setting, notification is made at specified intervals regardless of the change in
value. (The transmission interval may be slower than the set value due to the processing traffic.)
*The default value is OFF.
F2H, 04H, 01H, <Interval>, <inch/cm>, <ON/OFF>
<Interval> (0, 1 to 10[100msec units])
00H: Immediate response
01H: 100msec
to
0AH: 1000msec(1sec)
<inch/cm>
00H: inch
01H: cm
<ON/OFF>
00H: OFF (Microphone beam steering status notification is disabled)
01H: ON (Microphone beam steering status notification is enabled)
TOA Corporation
7/15
AM-CF1
Status request command
Status request (speaker output gain position)
This command requests the current gain position of the speaker output.
Once the AM-CF1 receives this command, it responds the current gain position value.
F0H, 03H, 11H, <Channel Attribute>, <Channel Number>
<Channel Attribute>
01H: Speaker Out channel (fixed value)
<Channel Number>
00H: Channel Attribute (fixed value)
(e.g.) Request the speaker output gain position of the unit
F0H, 03H, 11H, 01H, 00H
Status request (mute mode)
This command requests the current mute mode of the unit.
Once the AM-CF1 receives this command, it responds the current mute mode.
F0H, 03H, 18H, <Channel Attribute>, <Channel Number>
<Channel Attribute>
00H: Mic In channel
01H: Speaker Out channel
<Channel Number>
00H: Channel Attribute (fixed value)
(e.g.) Request the microphone mute mode of the unit
F0H, 03H, 18H, 00H, 00H
Status request (memory preset number)
This command requests the current memory preset number of the unit.
Once the AM-CF1 receives this command, it responds the current memory preset number.
F0H, 02H, 71H, 00H
(e.g.) Request preset number
F0H, 02H, 71H, 00H
TOA Corporation
8/15
AM-CF1
Status request (standby mode)
This command requests the current standby mode of the unit.
Once the AM-CF1 receives this command, it responds the current standby mode.
F0H, 02H, 72H, 00H
(e.g.) Request standby mode
F0H, 02H, 72H, 00H
TOA Corporation
9/15
AM-CF1
Status request (microphone beam steering setting)
This command requests the current microphone beam steering setting of the unit.
Once the AM-CF1 receives this command, it responds the current microphone beam steering setting.
F0H, 05H, 20H, 00H, 00H, 00H, 00H
(e.g.) Request the microphone beam steering setting
F0H, 05H, 20H, 00H, 00H, 00H, 00H
Status request (microphone beam steering position)
This command requests the current microphone beam steering position of AM-CF1.
Once the AM-CF1 receives this command, it responds the current microphone beam steering position.
F0H, 06H, 50H, 00H, 00H, 00H, 00H, <inch/cm>
<inch/cm>
00H: inch
01H: cm
(e.g.) Require the current microphone beam steering position
F0H, 06H, 50H, 00H, 00H, 00H, 00H, 00H
TOA Corporation
10/15
AM-CF1
■ Status information
Microphone beam steering position information
AM-CF1 notifies the current microphone beam steering position.
D0H, 06H, A0H, <X coordinate>, <Y coordinate>, <inch/cm>
<X coordinate> (-600.0 to 600.0[cm/inch])
An integer of two bytes with signs, expressed in big-endian decimal places.
<inch/cm> For inch: -2400 to 2400 [inch per 10 units] (-240.0 to 240.0 [inch])
<inch/cm> For cm: -6000 to 6000 [cm/10 units] (-600.0 to 600.0 [cm])
<Y coordinate> (0.0 to 600.0[cm/inch])
An unsigned two-byte integer expressed in big-endian decimal places.
<inch/cm> For inch: 0 to 2400 [inch per 10 units] (0.0 to 240.0 [inch])
<inch/cm> For cm: 0 to 6000 [cm/10 units] (0.0 to 600.0 [cm])
<inch/cm>
00H: inch
01H: cm
(e.g.) Beam steering position information: Notification X-coordinate-300.0 cm, Y-coordinate 600.0 cm
D0H, 06H, A0H, F4H, 48H, 17H, 70H, 01H
TOA Corporation
11/15
AM-CF1
Command List
Command
Log-in
Log-off
Speaker output gain setting (absolute
position)
Speaker output gain setting (step)
Mute mode setting
Recalling memory presets
Standby mode setting
Microphone beam steering setting
Status notification setting
Microphone beam steering status notification
setting
Status request (gain position)
Status request (mute mode)
Status request (memory preset number)
Status request (standby mode)
Status request (microphone beam steering
setting)
Status request (microphone beam steering
position)
Microphone beam steering position
information
Command code
80H, 20H, <User Name>, <Password>
81H, 00H
91H, 03H, <Channel Attribute>, <Channel Number>, <Position>
91H, 03H, <Channel Attribute>, <Channel Number>, <Step>
98H, 03H, <Channel Attribute>, <Channel Number>, <ON/OFF >
F1H, 02H, 00H, <Preset Number>
F3H, 02H, 00H, <Standby mode>
A0H, 05H, <Auto/Manual>, <Direction>, <Distance>, <inch/cm>
F2H, 02H, 00H, <ON/OFF >
F2H, 04H, 01H, <Interval>, <inch/cm>, <ON/OFF>
F0H, 03H, 11H, <Channel Attribute>, <Channel Number>
F0H, 03H, 18H, <Channel Attribute>, <Channel Number>
F0H, 02H, 71H, 00H
F0H, 02H, 72H, 00H
F0H, 05H, 20H, 00H, 00H, 00H, 00H
F0H, 06H, 50H, 00H, 00H, 00H ,00H, <inch/cm>
D0H, 06H, A0H, <X coordinate>, <Y coordinate>, <inch/cm>
TOA Corporation
12/15
AM-CF1
■ Communication Examples
Command
Log-in(admin, admin)
Log-off
Speaker output gain setting (0dB)
Speaker output gain setting
(3 step up)
Controller
80H,20H,61H,64H,6DH,69H,6EH,00H,
00H,00H,00H,00H,00H,00H,00H,00H,
00H,00H,61H,64H,6DH,69H,6EH,00H,
00H,00H,00H,00H,00H,00H,00H,00H,
00H,00H
81H,00H
91H,03H,01H,00H,3DH
91H,03H,01H,00H,43H
AM-CF1 Response
80H,01H,01H
For NACK responses, the third byte is
00H
Speaker output gain setting
(3 step down)
91H,03H,01H,00H,63H
Mute mode setting (ON)
Mute mode setting (OFF)
Microphone beam steering setting
(Auto)
98H,03H,00H,00H,01H
98H,03H,00H,00H,00H
A0H,05H,00H,00H,00H,00H,00H
Microphone beam steering setting
(Manual, 90deg, 240.0inch)
A0H,05H,01H,A6H,09H,60H,00H
Status notification setting (ON)
Status notification setting (OFF)
Microphone beam steering status
notification setting (ON)
Microphone beam steering status
notification setting (OFF)
Recalling memory presets
(preset1)
Recalling memory presets
(preset2)
Standby mode setting (ON)
Standby mode setting (OFF)
F2H,02H,00H,01H
F2H,02H,00H,00H
F2H,04H,01H,00H,00H,01H
81H,00H
91H,03H,01H,00H,3DH
91H,03H,01H,00H,2DH
When 2AH(-19db) before 3stepup,
become 2DH after 3stepup
91H,03H,01H,00H,2AH
When 2DH(-16db) before 3stepdown,
become 2AH after 3stepdown
98H,03H,00H,00H,01H
98H,03H,00H,00H,00H
A0H,05H,00H,00H,00H,00H,00H
The position is notified by the beam
steering position information command
every set time.
D0H,06H,A0H,F4H,48H,17H,70H,01H
A0H,05H,01H,A6H,09H,60H,00H
The position is notified by the
microphone beam steering position
information command.
F2H,02H,00H,01H
F2H,02H,00H,00H
F2H,04H,01H,00H,00H,01H
F2H,04H,01H,00H,00H,00H
F2H,04H,01H,00H,00H,00H
F1H,02H,00H,00H
F1H,02H,00H,00H
F1H,02H,00H,01H
F1H,02H,00H,01H
F3H,02H,00H,01H
F3H,02H,00H,00H
F3H,02H,00H,01H
F3H,02H,00H,00H
TOA Corporation
13/15
AM-CF1
■ Gain Table
00H
01H
02H
03H
04H
05H
06H
07H
08H
09H
0AH
0BH
0CH
0DH
0EH
0FH
10H
11H
12H
13H
14H
15H
16H
17H
18H
19H
1AH
1BH
1CH
1DH
1EH
1FH
Position
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
Gain(dB)
-∞
-60
-59
-58
-57
-56
-55
-54
-53
-52
-51
-50
-49
-48
-47
-46
-45
-44
-43
-42
-41
-40
-39
-38
-37
-36
-35
-34
-33
-32
-31
-30
20H
21H
22H
23H
24H
25H
26H
27H
28H
29H
2AH
2BH
2CH
2DH
2EH
2FH
30H
31H
32H
33H
34H
35H
36H
37H
38H
39H
3AH
3BH
3CH
3DH
3EH
3FH
Position
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
Gain(dB)
-29
-28
-27
-26
-25
-24
-23
-22
-21
-20
-19
-18
-17
-16
-15
-14
-13
-12
-11
-10
-9
-8
-7
-6
-5
-4
-3
-2
-1
0
0
0
Default value is 3DH
Position 00H is replaced to -60dB
TOA Corporation
14/15
AM-CF1
Revision History
Ver.
0.0.1
1.0.0
1.0.1
Date of revision
March 23, 2018
May 7, 2018
May 23, 2018
1.0.2
May 28, 2018
1.0.3
June 25, 2018
1.0.4
July 23, 2018
1.0.5
August 1, 2018
1.0.6
August 21, 2018
1.0.7
September 5, 2018
1.0.8
July 11, 2019
1.0.9
July 12, 2019
Contents of establishment and change
1st revision released
The item of “speaker mute” is added.
The communication example is corrected according to the
command sequence.
Example of channel fader gain is modified.
The explanation of switching for standby mode is corrected
The AM-CF1 response commands in "Communication example:
3stepdown" are corrected.
The mute mode setting speaker is added.
Default value (OFF) for status notification setting AM-CF1 is
added.
Status request (mute mode) speaker is added.
Log-in and log-off are added.
Status request (beam steering) is added.
The following communication commands examples are
corrected.
・Mute mode setting
・Standby mode setting
・Status request (standby mode)
・Status request (beam steering)
The Preset Setting name of the communication example is
modified.
The status request (beam steering) is changed to the beam
steering setting.
Microphone beam steering setting is changed.
Beam steering status notification setting is added.
Status request (beam steering setting) is added.
Status request (beam steering position) is added.
Beam steering position information is added.
Command List Beam Steering is changed.
Communication example Beam Steering is changed.
“*Note” description is deleted from the top page.
Command Configuration description is changed.
Data length of log-off is corrected.
Description for speaker output gain setting (absolute position) is
corrected.
Example data of speaker output gain setting (step) is corrected.
Description for microphone bean steering setting is corrected.
Description for microphone bean steering status notification
setting is corrected.
Description for status request (microphone beam steering
position) is corrected.
X-coordinate of microphone beam steering position information is
corrected in status request.
Command description in Command List is corrected.
A part of descriptions for speaker output gain setting (absolute
position) is deleted.
A part of descriptions for Gain table is deleted.
TOA Corporation
15/15
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertising