(Page 1 of 20 in this chapter)
Version
Chapter 5
Alphabetical Function Reference
5.1 Introduction
5.1.1 Function Summary
Low Level Call Control
Board Management
cdiAssertSignal 41
cdiDisableBattery 42
cdiEnableBattery 43
cdiGetBoardStatus 44
cdiGetSignalState 47
cdiReadThermometer 48
cdiStartDTMFDetector 49
cdiStartRing 51
cdiStartSignalDetector 53
cdiStartStatusMonitoring 55
cdiStartTimer 56
cdiStartTones 58
cdiStopDTMFDetector 60
cdiStopRing 61
cdiStopSignalDetector 62
cdiStopStatusMonitoring 63
cdiStopTimer 64
cdiStopTones 65
cdiUserLed 66
5.1 Introduction
This chapter provides a comprehensive, alphabetically-ordered reference to the CDI service functions. A prototype of each function is shown with the function description and details of all arguments and return values. A typical function description includes:
Prototype
The prototype is shown followed by a listing of the function's arguments. Natural MicroSystems data types include:
·
WORD
16-bit unsigned
·
DWORD
32-bit unsigned
·
INT16
16-bit signed
·
INT32
32-bit signed
·
BYTE
8-bit unsigned
If a function argument is a data structure, the complete data structure is defined. Refer to
Appendix C
for a description of all data structures and parameters.
Return Values
The return value for a function is either
SUCCESS
or an error code. For asynchronous functions, a return value of
SUCCESS
indicates the function was initiated. Subsequent events indicate the status of the operation.
Refer to
Appendix A
for a listing of all errors returned by CDI service functions.
Events
If events are listed, the function is asynchronous and is complete when the
DONE
event is returned. If there are no events listed, the function is synchronous.
Additional information such as reason codes and return values may be provided in the
value
field of the event.
Refer to
Appendix B
for details for all CDI service events and reason codes.
Example
Example functions which start with
Demo
are excerpts taken from demonstration function libraries shipped with the product.
Example functions which start with
my
are excerpts taken from sample application programs shipped with the product.
The notation
/* ... */
indicates additional code which is not shown.
5.1.1 Function Summary
This section summarizes the CDI service functions, organized by task:
Low level call control
Board management
Low Level Call Control
The following functions perform CDI service low-level call control:
Function
Description
cdiAssertSignal
Asserts a supervisory signaling pattern to the line.
cdiDisableBattery
Removes
the power to the station attached to a port.
cdiEnableBattery
Supplies power to the station attached to a port.
cdiGetSignalState
Gets the current state of the supervisory signaling bits.
cdiStartDTMFDetector
Enables the DTMF detector.
cdiStartRing
Starts ringing a station.
cdiStartSignalDetector
Starts monitoring the signaling bits.
cdiStartTimer
Starts (or restarts) a timer on a port.
cdiStartTones
Starts the transmission of a tone.
cdiStopDTMFDetector
Disables the DTMF detector.
cdiStopRing
Stops ringing a station.
cdiStopSignalDetector
Stops monitoring the signaling bits.
cdiStopTimer
Aborts the timer operation.
cdiStopTones
Stops the tone transmission.
Board Management
The following functions control CDI service board management:
Function
Description
cdiGetBoardStatus
Gets the current board status.
cdiReadThermometer
Gets the current temperature of a thermometer.
cdiStartStatusMonitoring
Registers the application to receive board status change events.
cdiStopStatusMonitoring
Unregisters the application from receiving board status change events.
cdiUserLed
Sets the user LED.
(Page 1 of 20 in this chapter)
Version
Want to send us feedback on our documentation? Email:
Tech_Pubs@nmss.com
Copyright © 2000, Natural MicroSystems, Inc. All rights reserved.
(Page 1 of 20 in this chapter) Version
(Page 1 of 20 in this chapter) Version