Difference between revisions of "SET TIMER"
From Zenitel Wiki
m (Text replacement - "<br\>" to "<br />") |
|||
| Line 6: | Line 6: | ||
!style="background:#ffdead;" |AMC 08.20 | !style="background:#ffdead;" |AMC 08.20 | ||
|- | |- | ||
| − | |colspan="3"|'''$ST L102 W 50<br | + | |colspan="3"|'''$ST L102 W 50<br />$ST L102''' <br /> '''$ST L102 W 50 L101 ‘my name’ U0'''<br />'''$ST L102 W 0 L101''' |
| − | |colspan="2" |''Set 5 second timer on station 102''<br | + | |colspan="2" |''Set 5 second timer on station 102''<br />''Stop all timers on station 102''<br />''Set 5 sec, on station 102, from 101''<br />''Stop timer on station 102, from 101'' |
|- | |- | ||
|colspan="5"|Start a timer or stop timer. When the timer expires, an [[EVENT_REPORT]] is generated, event type [[Event Timeout (Event Type)|EVH_EVENT_TIMEOUT]] = 21. The timer can be stopped before expiry by setting a zero timeout value. | |colspan="5"|Start a timer or stop timer. When the timer expires, an [[EVENT_REPORT]] is generated, event type [[Event Timeout (Event Type)|EVH_EVENT_TIMEOUT]] = 21. The timer can be stopped before expiry by setting a zero timeout value. | ||
| Line 15: | Line 15: | ||
|align=center|1||[[NET_OBJ_REF]] {[[ECL_STATION]]}||colspan="3"|Station to receive timeout event (event owner). ([[NRF_LOCAL_DIRNO]] and [[NRF_LOCAL_ENTITY]] allowed.) | |align=center|1||[[NET_OBJ_REF]] {[[ECL_STATION]]}||colspan="3"|Station to receive timeout event (event owner). ([[NRF_LOCAL_DIRNO]] and [[NRF_LOCAL_ENTITY]] allowed.) | ||
|- | |- | ||
| − | |align=center|2||[[UINT2]] <br | + | |align=center|2||[[UINT2]] <br />(optional)||colspan="3"|Timeout value, measured in 100 ms ticks. Default value is zero, which means stop timer. Max value will give a 1 hour 49 minute timeout. |
|- | |- | ||
| − | |align=center|3||[[NET_OBJ_REF]]<br | + | |align=center|3||[[NET_OBJ_REF]]<br /> {[[ECL_STATION]]}<br /> (optional) |
|colspan="3"|Station to be used as related-to parameter in timeout event. Null value allowed. (Only [[NRF_LOCAL_DIRNO]] allowed.) | |colspan="3"|Station to be used as related-to parameter in timeout event. Null value allowed. (Only [[NRF_LOCAL_DIRNO]] allowed.) | ||
|- | |- | ||
| − | |align=center|4||[[TEXT16]]<br | + | |align=center|4||[[TEXT16]]<br />(optional)||colspan="3"|Name of related-to parameter in timeout event (16 character). <br />Default value: Sending station’s name if specified. |
|- | |- | ||
| − | |align=center|5||[[UINT1]]<br | + | |align=center|5||[[UINT1]]<br />(optional)||colspan="3"|User Defined Properties ([[UDP]]) of related-to parameter in timeout event. |
Default value: 0. | Default value: 0. | ||
|- | |- | ||
Revision as of 10:55, 8 March 2016
| SET_TIMER | 0x008F | 143 | AMC 08.20 | |
|---|---|---|---|---|
| $ST L102 W 50 $ST L102 $ST L102 W 50 L101 ‘my name’ U0 $ST L102 W 0 L101 |
Set 5 second timer on station 102 Stop all timers on station 102 Set 5 sec, on station 102, from 101 Stop timer on station 102, from 101 | |||
| Start a timer or stop timer. When the timer expires, an EVENT_REPORT is generated, event type EVH_EVENT_TIMEOUT = 21. The timer can be stopped before expiry by setting a zero timeout value.
A station must be specified as owner of the timer. It is also possible to specify the “related-to” parameters to be used in the timeout EVENT_REPORT. A SET_TIMER will replace an existing running timer if both the owner station and related-to stations are identical. If none of the running timers are matching, a new independent timer is started. Omitting the related-to station has a special meaning for the stop operation: All timers with the specified owner station will be stopped. | ||||
| 1 | NET_OBJ_REF {ECL_STATION} | Station to receive timeout event (event owner). (NRF_LOCAL_DIRNO and NRF_LOCAL_ENTITY allowed.) | ||
| 2 | UINT2 (optional) |
Timeout value, measured in 100 ms ticks. Default value is zero, which means stop timer. Max value will give a 1 hour 49 minute timeout. | ||
| 3 | NET_OBJ_REF {ECL_STATION} (optional) |
Station to be used as related-to parameter in timeout event. Null value allowed. (Only NRF_LOCAL_DIRNO allowed.) | ||
| 4 | TEXT16 (optional) |
Name of related-to parameter in timeout event (16 character). Default value: Sending station’s name if specified. | ||
| 5 | UINT1 (optional) |
User Defined Properties (UDP) of related-to parameter in timeout event.
Default value: 0. | ||
| Response: | None | |||