DOC

reporting_sw_hld.doc - Curtin University of Technology Australia

By Chris Ferguson,2014-04-15 02:46
6 views 0
This document describes the software high-level design for the reporting section of the UL 1-2 Loop Panel. Scope. The intended audience of this document is:

Reporting Software High-Level

    Design

    UL 1-2 Loop Panel (3510)

    Document No Ampac_UL3510_Rpt_SW_HLD Revision 1.0.0 Draft H

    Approved by Software Designer Projects Manager Engineering Manager

     Name

     Signature

     Date

     AMPAC Confidential, ? AMPAC 2004

    Software Development Reporting Software High-Level Design (UL 1-2 Loop Panel (3510))

    Document History

    Date Author Revision Description 19 March 2004 S.Breet 1.0.0 Draft A Initial creation 30 April 2004 S.Breet 1.0.0 Draft B Updated flow diagram of SIA DC-03 Data

    Block Movement 3 May 2004 S.Breet 1.0.0 Draft C Updated flow diagram of SIA DC-03 Data

    Block Movement 5 May 2004 S.Breet 1.0.0 Draft D Updated flow diagram of SIA DC-03 Data

    Block Movement 30 June 2004 S.Breet 1.0.0 Draft E Updated all sections due to changes in

    design.

    2 July 2004 S.Breet 1.0.0 Draft F Updated main reporting state machine

    state diagram. 7 July 2004 S.Breet 1.0.0 Draft G Updated main reporting state machine

    state diagram (due to test signal

    transmission state machine updates). 8 July 2004 S.Breet 1.0.0 Draft H Updated reporting procedure update

    (continued) flowchart.

    This material is confidential to AMPAC and may not be disclosed in whole or

    in part to any third party nor used in any manner whatsoever other than for the

    purposes expressly consented to by AMPAC in writing.

    This material is also copyright and may not be reproduced, stored in a retrieval

    system or transmitted in any form or by any means in whole or in part without

    the express written consent of AMPAC.

    Ampac_UL3510_Rpt_SW_HLD AMPAC Confidential, ? AMPAC 2004 Page 2 of 17 Revision 1.0.0 Draft H/ 15 April, 2010

Software Development Reporting Software High-Level Design (UL 1-2 Loop Panel (3510))

    Table of Contents

    1. Introduction ..................................................................................................................... 5 1.1 Purpose .............................................................................................................................. 5 1.2 Scope ................................................................................................................................. 5 1.3 Typographical Conventions ................................................................................................ 5 1.4 Acronyms and Abbreviations .............................................................................................. 5 1.5 Definitions ........................................................................................................................... 6 1.6 References ......................................................................................................................... 6 2. Reporting Overview ........................................................................................................ 7 3. Reporting Architecture ................................................................................................... 8 3.1 Reporting Component ......................................................................................................... 8

    3.1.1 Responsibilities ................................................................................................................................. 8

    3.1.2 Interfaces .......................................................................................................................................... 9

    3.1.2.1 IF_Rpt_Sys .................................................................................................................................................. 9

    3.1.2.2 IF_Rpt_Acc .................................................................................................................................................. 9 3.2 SIA Component .................................................................................................................. 9

    3.2.1 Responsibilities ................................................................................................................................. 9

    3.2.2 Interfaces .......................................................................................................................................... 9

    3.2.2.1 IF_SIA_Sys .................................................................................................................................................. 9

    3.2.2.2 IF_SIA_Event_Rpt ........................................................................................................................................ 9

    3.2.2.3 IF_SIA_Result_Reg .................................................................................................................................... 10

    3.2.2.4 IF_SIA_Acc ................................................................................................................................................ 10 3.3 Modem Component .......................................................................................................... 10

    3.3.1 Responsibilities ............................................................................................................................... 10

    3.3.2 Interfaces ........................................................................................................................................ 10

    3.3.2.1 IF_Modem_Sys .......................................................................................................................................... 10

    3.3.2.2 IF_Modem_Acc .......................................................................................................................................... 10 4. State Diagrams .............................................................................................................. 11 4.1 Main reporting state machine ............................................................................................ 11 5. Flowcharts ..................................................................................................................... 12 5.1 Reporting Procedure Initialise ........................................................................................... 12 5.2 Reporting Procedure Update ............................................................................................ 13

    5.3 SIA DC-05 (Contact ID Protocol) Message Transmission ................................................. 15

    5.4 SIA DC-03 (“SIA Format” Protocol) Transmitter Initiated Session Establishment .............. 16 5.5 SIA DC-03 Block Protocol (Data Block Movement) ........................................................... 17

List of Tables

    Table 1. Typographical conventions ................................................................................................................... 5 Table 2. Acronym and Abbreviation List ............................................................................................................. 5 Table 3. Definition List ........................................................................................................................................ 6

    Table 4. Reference List ...................................................................................................................................... 6

Ampac_UL3510_Rpt_SW_HLD AMPAC Confidential, ? AMPAC 2004 Page 3 of 17 Revision 1.0.0 Draft H/ 15 April, 2010

Software Development Reporting Software High-Level Design (UL 1-2 Loop Panel (3510))

    List of Figures

    Figure 1. Reporting Component Diagram ............................................................................................................ 8 Figure 2. Main reporting state machine ............................................................................................................. 11 Figure 3. Reporting procedure initialise ............................................................................................................. 12 Figure 4. Reporting procedure update ............................................................................................................... 13 Figure 5. Reporting procedure update (continued)............................................................................................ 14 Figure 6. SIA DC-05 Message Transmission .................................................................................................... 15 Figure 7. SIA DC-03 Transmitter initiated session establishment ..................................................................... 16 Figure 8. SIA DC-03 Data Block Movement ...................................................................................................... 17

Ampac_UL3510_Rpt_SW_HLD AMPAC Confidential, ? AMPAC 2004 Page 4 of 17 Revision 1.0.0 Draft H/ 15 April, 2010

Software Development Reporting Software High-Level Design (UL 1-2 Loop Panel (3510))

    1. Introduction

    1.1 Purpose

    This document describes the software high-level design for the reporting section of the UL 1-2 Loop

    Panel.

    1.2 Scope

    The intended audience of this document is:

    ? Members of the software development team involved in the Detailed Design (DD) and

    implementation/integration of software components for the UL 1-2 Loop Panel.

    ? Members of the software test team, doing unit, integration, system or acceptance testing on the

    UL 1-2 Loop Panel.

    ? Project manager(s) of the UL 1-2 Loop Panel project.

    1.3 Typographical Conventions

    The following typographical conventions are used throughout this document:

    Style Meaning

    This is important Used for emphasis

    document The name of a document.

     Data to be filled in by the user

    Table 1. Typographical conventions

1.4 Acronyms and Abbreviations

    The following acronyms and abbreviations are used throughout this document:

    Acronym Description

    FACP Fire Alarm Control Panel

    HLD High-Level Design

    IF Interface

    Modem Modulator demodulator

    SIA Security industry Association

    TBD To be defined

    UL Underwriters Laboratories Inc.

    Table 2. Acronym and Abbreviation List

    Ampac_UL3510_Rpt_SW_HLD AMPAC Confidential, ? AMPAC 2004 Page 5 of 17 Revision 1.0.0 Draft H/ 15 April, 2010

Software Development Reporting Software High-Level Design (UL 1-2 Loop Panel (3510))

    1.5 Definitions

    The following definitions are applicable within this document:

    Term Description

    Table 3. Definition List

    1.6 References

    Tag Description

    Underwriters Laboratories - UL864 Standard for Control Units and [UL864]

    Accessories for Fire Alarm Systems, Edition 9, 30 September 2003

    SIA Digital Communication Standard Ademco Contact ID Protocol [SIA DC-05]

    for Alarm System Communications, SIA DC-05-1999.09,

    September 1999

    SIA Digital Communication Standard “SIA Format” Protocol for [SIA DC-03]

    Alarm System Communications, SIA DC-03-1990.01 (R2000.11),

    February 1993

    Table 4. Reference List

    Ampac_UL3510_Rpt_SW_HLD AMPAC Confidential, ? AMPAC 2004 Page 6 of 17 Revision 1.0.0 Draft H/ 15 April, 2010

Software Development Reporting Software High-Level Design (UL 1-2 Loop Panel (3510))

    2. Reporting Overview

    Reporting is the process whereby reportable events are being transmitted from the protected

    premises to a remote supervising station (See sections 37 to 40 of [UL864]). A range of

    communication paths may be used for transmitting the event(s), including public switched telephone

    networks, public cellular networks, private radio networks, etc. A complete list of possible

    communication paths is provided in [UL864]. The Ampac FACP will implement two public switched

    telephone network connections for these communication paths, in accordance with section 40.3.2.9 of

    [UL864]. The protocols to be used for reporting are described in [SIA DC-03] and [SIA DC-05]. The

    protocol selection will be a user-selectable configuration item of the FACP.

Ampac_UL3510_Rpt_SW_HLD AMPAC Confidential, ? AMPAC 2004 Page 7 of 17 Revision 1.0.0 Draft H/ 15 April, 2010

Software Development Reporting Software High-Level Design (UL 1-2 Loop Panel (3510))

    3. Reporting Architecture

    The software architecture of the reporting section of the system software is shown in the component

    diagram below (Figure 1). The main components of the reporting section is:

    ? Reporting

    ? SIA

    ? Modem

    These components are described in detail hereafter. The other components in the diagram are shown

    to indicate the interface between these and the reporting section, so that the reader can get a

    complete picture of where reporting fits into the system. These components will however not be

    described in detail, since only the interfaces that they provide will be used by the reporting section.

    IF_SysDB_AccIF_Cfg_Acc

    SystemConfigDatabase

    IF_Rpt_SysIF_Logs_Acc

    ReportingLogs

    IF_Rpt_Acc

    IF_SIA_AccIF_SIA_Result_Reg

    SIAModem

    IF_SIA_Event_RptIF_Modem_Acc

    IF_SIA_SysIF_Modem_Sys

    Figure 1. Reporting Component Diagram

    3.1 Reporting Component

    3.1.1 Responsibilities

    a) Enquire from the logs component (via the logs access interface IF_Logs_Acc) whether there are

    reportable events to be reported. The order of these queries must be according to the priority, as

    described in section 40.3.2.3 of [UL864].

    Ampac_UL3510_Rpt_SW_HLD AMPAC Confidential, ? AMPAC 2004 Page 8 of 17 Revision 1.0.0 Draft H/ 15 April, 2010

Software Development Reporting Software High-Level Design (UL 1-2 Loop Panel (3510))

    b) Obtain all relevant information regarding a reportable event from the system database and

    configuration components, via the access interfaces to these components (IF_SysDB_Acc and

    IF_Cfg_Acc). This is information that is not readily available as part of the logged event, for

    example all information regarding the reporting accounts.

    c) Format the reportable event information according to [SIA DC-03] and [SIA DC-05].

    d) Submit the formatted event information to the SIA module (reporting protocol handler), which will

    implement the reporting protocol.

    e) Obtain the protocol result form the SIA module and implement all necessary retry strategies in

    case an error has occurred. Also keep track of the type or error(s) (e.g. reporting station failure

    and/or line failure).

    f) Update the logs component when an event has been successfully reported.

    g) Initiate and supervise the transmission of test signals to remote supervising station(s), in order to

    satisfy the requirement of section 4.3.2.13 in [UL864]. 3.1.2 Interfaces

    The following interfaces will be provided:

    3.1.2.1 IF_Rpt_Sys

    This is the “system” interface, through which the reporting component can be initialised and updated

    periodically. This interface can also be used to enable/disable line monitoring done by the reporting

    component.

    3.1.2.2 IF_Rpt_Acc

    This is the “access” interface to the reporting component. This interface will be used as follows:

    ? By the SIA component to obtain reporting information, such as the telephone number of the

    reporting station and the protocol to be used.

    ? By the system database component to determine whether line failure(s) and/or reporting station

    failure(s) has occurred.

    ? By the logs component to determine the index of the event currently being reported. 3.2 SIA Component

    3.2.1 Responsibilities

    a) Implement the protocols as described in [SIA DC-03] and [SIA DC-05].

    b) Transmit reportable event(s), as presented to it by the reporting component, to the remote

    supervising station, using the protocol indicated by the reporting component and using the

    services provided by the modem component via interface IF_Modem_Acc.

    c) Inform the reporting component about the result of an event report. 3.2.2 Interfaces

    The following interfaces will be provided:

    3.2.2.1 IF_SIA_Sys

    This is the “system” interface, through which the SIA component can be initialised and updated

    periodically.

    3.2.2.2 IF_SIA_Event_Rpt

    This interface is used by the reporting component to submit a formatted event report to the SIA

    component.

    Ampac_UL3510_Rpt_SW_HLD AMPAC Confidential, ? AMPAC 2004 Page 9 of 17 Revision 1.0.0 Draft H/ 15 April, 2010

Software Development Reporting Software High-Level Design (UL 1-2 Loop Panel (3510))

    3.2.2.3 IF_SIA_Result_Reg

    This interface is used to register a callback with the SIA component to receive protocol status updates. 3.2.2.4 IF_SIA_Acc

    This is the “access” interface to the SIA component. This interface will be used as follows:

    ? By the reporting component to determine whether an SIA session is idle or disconnected.

    ? By the reporting component to get the time duration that a session has been idle or disconnected.

    ? By the reporting component to instruct the SIA component to end a session. 3.3 Modem Component

    3.3.1 Responsibilities

    Provides the following modem functionality:

    ? Initiate and terminate different call types (e.g. initiate/terminate data call, initiate call types

    specified in [SIA DC-03] and [SIA DC-05]).

    ? Enable transmission and reception of data and tones over the public switched telephone network. 3.3.2 Interfaces

    The following interfaces will be provided:

    3.3.2.1 IF_Modem_Sys

    This is the “system” interface, through which the modem component can be initialised and updated

    periodically.

    3.3.2.2 IF_Modem_Acc

    This is the “access” interface to the modem component. This interface will be used as follows:

    ? By the SIA component to initiate a call, monitor call progress, transmit/receive data and tones

    and end a call.

    ? By the reporting component to get detailed dial status information.

    ? By the reporting component to monitor audio activity on a line.

Ampac_UL3510_Rpt_SW_HLD AMPAC Confidential, ? AMPAC 2004 Page 10 of 17 Revision 1.0.0 Draft H/ 15 April, 2010

Report this document

For any questions or suggestions please email
cust-service@docsford.com