This the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Prodys

1 - Prodys ProntoNet

This connection type controls and monitors a Prodys ProntoNet codec over its TCP control interface.

BTConnect polls the device regularly and exposes per-line status information as read-only parameters. It also provides write-only parameters for placing, answering, and hanging up calls.

Configuration

On the network tab, the following settings are available:

  • Host: The IP address or host name of the ProntoNet device.
  • Port: The TCP port of the ProntoNet control interface. The default port is 50031.

On the settings tab, the following additional options are available:

  • Poll Interval: The polling interval in seconds. The default is 2.
  • Line Count: The number of codec lines to expose. The default is 1; the maximum supported value is 2.

When the connection is established, BTConnect performs the ProntoNet login handshake automatically and then starts polling the configured lines.

Parameters

For each configured line, the following parameters are created:

  • line/<id>/status (enum, read-only) - the current line status.
  • line/<id>/connected (boolean, read-only) - true while the line is connected.
  • line/<id>/number (string, read-only) - the current or last remote number reported by the device.
  • line/<id>/disconnectioncode (integer, read-only) - the last disconnection code reported for the line.
  • line/<id>/calltype (enum, read-only) - the current call type.
  • line/<id>/outgoing/number (string, write-only) - the number to be used for the next outgoing call on that line.
  • line/<id>/outgoing/calltype (enum, write-only) - the call type to be used for the next outgoing call on that line.
  • line/<id>/action/call (trigger, write-only) - places a call using the currently configured outgoing number and call type.
  • line/<id>/action/callfrombook (integer, write-only) - places a call using the specified phonebook entry number.
  • line/<id>/action/answer (trigger, write-only) - answers an incoming call on the line.
  • line/<id>/action/hangup (trigger, write-only) - hangs up the line.

The line index <id> starts at 1.

Enums

The status parameter uses the ProntoNet line status enum values, such as:

  • Disconnected
  • Disconnecting
  • Calling
  • ReceivingCall
  • Connected_Called
  • Connected_Received
  • CallRejected
  • NotAvailable

The calltype parameters use the ProntoNet IP call type enum values:

  • UnicastBidirectional
  • UnicastUnidirectional_Tx
  • Multicast_Tx
  • Multicast_Rx
  • UnicastUnidirectional_Rx

Typical Usage

To place a call on line 1:

  • Set line/1/outgoing/number to the desired destination.
  • Optionally set line/1/outgoing/calltype.
  • Trigger line/1/action/call.

To answer or hang up a call, trigger line/1/action/answer or line/1/action/hangup respectively.

2 - Prodys Quantum/IkusNet

This connection type controls and monitors a Prodys Quantum/IkusNet codec over its TCP external control interface.

BTConnect polls the device regularly and exposes status information for each configured codec and line combination. It also provides write-only parameters for placing, answering, and hanging up calls.

Configuration

On the network tab, the following settings are available:

  • Host: The IP address or host name of the Quantum/IkusNet device.
  • Port: The TCP port of the external control interface. The default port is 50031.

On the settings tab, the following additional options are available:

  • Poll Interval: The polling interval in seconds. The default is 2.
  • Codec Count: The number of codecs to expose. Supported values are 1 or 2.
  • Line Count: The number of lines to expose per codec. Supported values are 1 to 10.
  • User: Optional user name field stored in the configuration.
  • Password: Optional password field stored in the configuration.

BTConnect performs the IkusNet external-protocol handshake automatically when the connection is established and then starts polling the configured codec lines.

Parameters

For each configured codec, the following write-only parameters are created:

  • codec/<id>/outgoing/address (string, write-only) - the destination address to be used for the next outgoing call.
  • codec/<id>/outgoing/calltype (enum, write-only) - the call type to be used for the next outgoing call.
  • codec/<id>/outgoing/callcontent (enum, write-only) - the content type to be used for the next outgoing call.
  • codec/<id>/action/call (trigger, write-only) - places a call using the currently configured outgoing address, call type, and call content.
  • codec/<id>/action/callfrombook (integer, write-only) - places a call using the specified phonebook entry number.
  • codec/<id>/action/answer (trigger, write-only) - answers an incoming call on the codec.
  • codec/<id>/action/hangup (trigger, write-only) - hangs up the codec.

For each configured codec line, the following read-only parameters are created:

  • codec/<id>/line/<line>/status (enum, read-only) - the current line status.
  • codec/<id>/line/<line>/connected (boolean, read-only) - true while the line is connected.
  • codec/<id>/line/<line>/address (string, read-only) - the current or last remote address reported by the device.
  • codec/<id>/line/<line>/disconnectioncode (integer, read-only) - the last disconnection code reported for the line.
  • codec/<id>/line/<line>/calltype (enum, read-only) - the current call type for the line.

The codec index <id> starts at 1. Line numbering also starts at 1.

Codec 1 corresponds to the Quantum/IkusNet program lines, while codec 2 corresponds to the talkback lines.

Enums

The status parameter uses IkusNet line status enum values, such as:

  • Disconnected
  • Disconnecting
  • Calling
  • ReceivingCall
  • Connected_Called
  • Connected_Received
  • NotAvailable
  • Reconnecting
  • Connected_TestingLine
  • Connected_UploadingFile
  • Connected_DownloadingFile
  • Initializing

The calltype parameters use IkusNet IP call type enum values:

  • Invalid
  • UnicastBidirectional
  • UnicastUnidirectional_Tx
  • UnicastUnidirectional_Rx
  • Multicast_Tx
  • Multicast_Rx
  • UnicastBidirectionalAsymmetrical

The outgoing/callcontent parameter uses IkusNet call content enum values:

  • Invalid
  • Audio
  • Video
  • AudioVideo

Typical Usage

To place a call on codec 1:

  • Set codec/1/outgoing/address to the desired destination.
  • Optionally set codec/1/outgoing/calltype.
  • Optionally set codec/1/outgoing/callcontent.
  • Trigger codec/1/action/call.

To answer or hang up a call, trigger codec/1/action/answer or codec/1/action/hangup respectively.