19.1. APOTS subsystem activation

19.1. APOTS subsystem activation
	Chapter 19. APOTS

APOTS subsystem is a part of CTISYS providing integration of audio-in/audio-out device of M/B (for example J4125) or attached USB AUDIO device to Abilis voice system.

either as audio-in/audio-out of Abilis softphone (PcPhone);
public address with connected microphone/loudspeakers.

There are several necessary configuration steps to have APOTS subsystem working.

19.1.1. AUDIOUSB device

AUDIOUSB device configuration must be added to configuration to be bound with USB AUDIO device:

[12:22:24] ABILIS_CPX:a dev:audiou-1

COMMAND EXECUTED

It then appears in the listing of devices:

[12:22:24] ABILIS_CPX:d dev

--------------- Active Watchdog and MFxx Resources (read only): ---------------
Dev         Run Physical Res                                 SlotId  Addr  Irq
-------------------------------------------------------------------------------
MF          Yes Mf . . . . . . . . . . . . . . . . . . . . .     75   PCI ( 12)

------------------ Active PCI Devices and Physical Resources: -----------------
Dev         Run Physical Res or CTI Port                     SlotId  Addr  Irq
-------------------------------------------------------------------------------
ASY-1       Yes Async-1  . . . . . . . . . . . . . . . . . .      -   3F8    4
ETH-1       Yes Eth-1  . . . . . . . . . . . . . . . . . . .     18   PCI ( 15)
ETH-2       Yes Eth-2  . . . . . . . . . . . . . . . . . . .     72   PCI ( 15)
ETH-3       Yes Eth-3  . . . . . . . . . . . . . . . . . . .     73   PCI ( 11)
BSE-1       Yes 31..38, 101..140 . . . . . . . . . . . . . .     74   PCI (  5)

------------------ Active USB Devices and Physical Resources: -----------------
Dev         Run Con Physical Res or CTI Port               USBPORTID
-------------------------------------------------------------------------------
AUDIOU-1    No  No  AudioU-1 . . . . . . . . . . . . . . . NONE

	Warning
	It's needed to save the configuration (use the command save conf) and restart the system (use the command warm start).

19.1.1.1. AUDIOUSB device chip compatibility

After adding the AUDIOU-1 device and restarting, check if the device is detected correctly by Abilis. Below you can see the compatible and supported chips in Abilis:

AXAGON ADA devices:

[12:22:20] ABILIS_CPX:d usbdev

uhci-ohci:DISABLED

ID  VendorId/Manufacturer     ProductId/Product                Ver Sp UsbPortId  DEV
-----------------------------------------------------------------------------------------
1   0000 On Time              0000 XHCI Virtual Root Hub      0.00 -  0          -
2   0D8C C-Media Electronics  0014 USB Audio Device           1.00 F  0.2        AUDIOU-1

[12:22:20] ABILIS_CPX:d usbdev

uhci-ohci:DISABLED

ID  VendorId/Manufacturer     ProductId/Product                Ver Sp UsbPortId  DEV
-----------------------------------------------------------------------------------------
1   0000 On Time              0000 XHCI Virtual Root Hub      0.00 -  0          -
2   0D8C C-Media Electronics  0043 USB Advanced Audio Device  1.05 F   0.2        AUDIOU-1

[12:22:20] ABILIS_CPX:d usbdev

uhci-ohci:DISABLED

ID  VendorId/Manufacturer     ProductId/Product                Ver Sp UsbPortId  DEV
-----------------------------------------------------------------------------------------
1   0000 On Time              0000 XHCI Virtual Root Hub      0.00 -  0          -
2   0C76                      1711 USB AUDIO DEVICE           1.00 F  0.2         AUDIOU-1

[12:22:20] ABILIS_CPX:d usbdev

uhci-ohci:DISABLED

ID  VendorId/Manufacturer     ProductId/Product                Ver Sp UsbPortId  DEV
-----------------------------------------------------------------------------------------
1   0000 On Time              0000 XHCI Virtual Root Hub      0.00 -  0          -
2   0D8C C-Media Electronics  013C USB PnP Sound Device       1.00 F  0.2        AUDIOU-1

Yealink WH62:

[12:22:20] ABILIS_CPX:d usbdev

uhci-ohci:DISABLED

ID  VendorId/Manufacturer     ProductId/Product                Ver Sp UsbPortId  DEV
-----------------------------------------------------------------------------------------
1   0000 On Time              0000 XHCI Virtual Root Hub      0.00 -  0          -
2   6993 Yealink              B017 Yealink WH62               1.01 H  0.1        AUDIOU-1

Mini Abilis J4125 embedded audio port:

[12:22:20] ABILIS_CPX:d usbdev

uhci-ohci:DISABLED

ID  VendorId/Manufacturer     ProductId/Product                Ver Sp UsbPortId  DEV
-----------------------------------------------------------------------------------------
1   0000 On Time              0000 XHCI Virtual Root Hub      0.00 -  0          -
2   0573 CSCTEK               1573 USB Audio and HID         80.07 F  0.7         AUDIOU-1

	Warning
	If you have a different chip than the ones above, it means that the device is not supported.

	Note
	If the chip matches but is not detected in Abilis, then check the USBPORTID in the configuration (D DEV).

19.1.2. APOTS device

APOTS device must be added to configuration to be bound with AUDIOU and CTISYS:

[12:22:25] ABILIS_CPX:a dev:apots

COMMAND EXECUTED

It then appears in the listing of devices:

[12:22:25] ABILIS_CPX:d dev

--------------- Active Watchdog and MFxx Resources (read only): ---------------
Dev         Run Physical Res                                 SlotId  Addr  Irq
-------------------------------------------------------------------------------
MF          Yes Mf . . . . . . . . . . . . . . . . . . . . .     75   PCI ( 12)

------------------ Active PCI Devices and Physical Resources: -----------------
Dev         Run Physical Res or CTI Port                     SlotId  Addr  Irq
-------------------------------------------------------------------------------
ASY-1       Yes Async-1  . . . . . . . . . . . . . . . . . .      -   3F8    4
ETH-1       Yes Eth-1  . . . . . . . . . . . . . . . . . . .     18   PCI ( 15)
ETH-2       Yes Eth-2  . . . . . . . . . . . . . . . . . . .     72   PCI ( 15)
ETH-3       Yes Eth-3  . . . . . . . . . . . . . . . . . . .     73   PCI ( 11)
APOTS-25    No  485..500 . . . . . . . . . . . . . . . . . .      -     - (  -)
BSE-1       Yes 31..38, 101..140 . . . . . . . . . . . . . .     74   PCI (  5)

------------------ Active USB Devices and Physical Resources: -----------------
Dev         Run Con Physical Res or CTI Port               USBPORTID
-------------------------------------------------------------------------------
AUDIOU-1    No  No  AudioU-1 . . . . . . . . . . . . . . . NONE

	Warning
	It's needed to save the configuration (use the command save conf) and restart the system (use the command warm start).

19.1.3. CTI APOTS port configuration

APOTS port (CTIP:491) needs to have an assigned number to be used as a part of PBX port group (98 must be replaced by required number):

[12:50:58] ABILIS_CPX:s p ctip:485 num:98 

COMMAND EXECUTED

Add a user:

[12:51:58] ABILIS_CPX:a user:aphone pwd:aphonepwd 

COMMAND EXECUTED

Configure the OPC monitored service.

[12:51:58] ABILIS_CPX:s user:aphone opc-monitor:ctip 

COMMAND EXECUTED

Caution

OPC requires SoftPBX licence.

It is necessary to activate OPC subsystem to let our soft-phone solution work.

[12:51:58] ABILIS_CPX:a res:opc

COMMAND EXECUTED

	Warning
	It's needed to save the configuration (use the command save conf) and restart the system (use the command warm start).

Assigning the user for CTI port 485.

[12:50:58] ABILIS_CPX:s user:aphone ctip:485 

COMMAND EXECUTED

	Note
	The APOTS have the same behavior as the POTS.

[15:25:44] ABILIS_CPX:d p ctip:485      

CTIP:485 - Not Saved (SAVE CONF), Not Refreshed (INIT) ------------------------
Act     DESCR:aphone
Run     card:APOTS-25<1>                USER:aphone
        OPSTATE:UP        LOG:NO        AUDIORES:AudioU-1      TYPE:USER
        signalling:APOTS                HOLD:YES     CT:ICT    SS:YES
        DEVICE:HEADSET    
        NUM:98                          ADDRBOOK-NUM:NUM

	Tip
	The “Not Saved (SAVE CONF)” message is displayed every time the configuration is modified but not saved with the save conf command. The “Not Refreshed (INIT)” message is displayed every time the port configuration is modified but not refreshed with the init ctisys command. These messages will disappear after save conf or init ctisys commands.

19.1.4. CTI Routing configuration

Add a CTI routing for incoming calls:

[12:55:58] ABILIS_CPX:a ctir pr:0 poi:pbx sr:* gi:G0 out:485 cdi:98 sp:64000 descr:Incoming_calls 

COMMAND EXECUTED

Add a CTI routing for outgoing calls to route calls to a remote cluster (for example:site2):

[12:55:58] ABILIS_CPX:a ctir pr:1 poi:485 out:site2 cdi:0?* sp:64000 descr:Outgoing_calls 

COMMAND EXECUTED

Type the following command to view CTIR Routings:

[16:02:05] ABILIS_CPX:d ctir

- Not Saved (SAVE CONF), Not Refreshed (INIT) ---------------------------------
Last change: 27/02/2024 18:47:26

---+------+------------------+----------+--------------------+--------------------
PR |[DESCR]
   |BCI   |POI |SR      |GI  |OUT       |CDI                 |CDO
ACT|NEXT        |LAST        |EEC |T301 |CGI                 |CGO
EDT|SP    |SC   |DJ   |MJ    |FMDJ|FMMJ |SDI                 |SDO
   |SPOUT |SCOUT|DJOUT|MJOUT |LCS |LCST |SGI                 |SGO
   |                         |BCO       |RGI                 |RGO
   |FMRLY |FAXSP|MODSP|FMLVL |ECM |UDT  |IG  |OG  |SG        |DL  |DH
   |CODERS
   |CODERSOUT
   |TI1 .. TI5
----------------------------------------------------------------------------------
0   [Incoming_calls]
    VOICE  PBX  *        G0   485        98                   *                   
    NO           ANY          NO   Dft   *                    *                   
    64000  Sys   Sys   Sys    Sys  Sys   *                    *                   
----------------------------------------------------------------------------------
1   [Outgoing_calls]
    VOICE  485  #        #    site2      0?*                  *                   
    NO           ANY          NO   Dft   *                    *                   
    64000  Sys   Sys   Sys    Sys  Sys   *                    *

	Warning
	Changes made on the CTI routing table aren't immediately active. To activate them, execute the initialization command init ctir.

	Note
	For more examples, see CTIR Routings.

19.1.5. Abilis softphone (PcPhone)

APOTS uses PCphone web interface. No requirements are necessary for use with APOTS. Go to PCphone page http://192.168.1.1/sys/pcphone/index.htm (the IP is default, in your case it may differ) insert User name and Password previously created.