Program Dokumentation PC Software Skrevet af. Gruppen. Version 1.0

Transkript

1 Program Dokumentation PC Software Skrevet af Gruppen. Version 1.0

2 Indholds fortegnelse 1. INDLEDNING FORMÅL REFERENCER VERSIONSHISTORIE DEFINITIONER DOKUMENTATIONENS OPBYGNING GENEREL BESKRIVELSE PROGRAMMETS OMGIVELSER FUNKTIONEL BESKRIVELSE PROGRAM OVERSIGT GRÆNSEFLADER EKSTERNE GRÆNSEFLADER RS-232 Seriel port Registrerings databasen i Windows Internettet ( ) Operatør GuardTech Database INTERNE GRÆNSEFLADER GUARDTECH DATABASEN DATABASEN TABELLER Tabellen Log Tabellen Units Tabellen Users FORESPØRGSLER Forespørgselen LogAsc Forespørgselen LogCountTotal Forespørgselen UnitsAsc Forespørgselen UsersAsc PROCESSER FÆLLES MODULER CGuardTechRegDb CGuardUnitsRecordSet CGuardUsersRecordSet HOVED PROGRAM KOMMUNIKATIONS THREAD OVERSÆTTELSE OVERSÆTTELSES-HARDWARE OVERSÆTTELSES-SOFTWARE Kilde filer H filer Ressource filer OVERSÆTTELSE INSTALLATION BILAG GuardTech Projekt 2

3 1.1. Formål 1. Indledning Programmet er den centrale enhed i overvågnings systemet. Dette vil sige at det er dennes opgave at polle alle enhederne på RS-485 bussen, og så tage stilling til alt hvad der sker, dette vil f.eks. sige at det er denne enhed der udløser en alarm hvis der er en sensor der bliver udløst. Vi har valgt at lave softwaren til denne enhed i Visual C++ under Windows 95. Til at begynde med havde vi regnet med at det skulle have været skrevet i Borland C under Dos. Grunden til at vi valgte Visual C++ blandt andet fordi at vi skulle lave database programmering, og det er der en del problemstillinger omkring under Dos, hvor vi under Windows 95 kunne benytte database kommunikations standarten ODBC. Derudover valgte vi Visual C++ fordi at det er lettere at lave et program der køre flere threads samtidig under Windows 95. Og sidst for at lette arbejdet med at lave brugerfladen, dette er en del hurtigere end under Dos Referencer Der henvises til følgende dokumenter. - Kravspecifikation - Accepttest specifikation - Accepttest rapport - År 2000 test rapport - Brugervejledning 1.3. Versionshistorie Vers. Dato Init. Status Versionen omfatter Afleveret Aflevering til kunden, inklusiv bilag Definitioner Alle variabler i koden der begynder med m_ er member variabler i en class, hvis det første tegn i variabel navnet efter m_ er skrevet med småt så beskriver dette variablens type foreksempel så er et i en int, s er en string og l er en CListCtrl Dokumentationens opbygning Dokumentet er skrevet til en programmør som skal vedligeholde eller udvide softwaren, opbygningen af dokumenteret er efter SPU standarten. GuardTech Projekt 3

4 2.1. Programmets omgivelser 2. Generel beskrivelse RS-232 Seriel port GuardTech PC Software GuardTech Database Registrerings databasen Windows 95 Internettet ( ) Operatør Operatøren har mulighed for at betjene softwaren på Pc en, der henvises til bruger vejledningen for yderligere informationer omkring betjening af softwaren. Internettet, systemet kan sende en når en alarm udløses. Det er muligt at konfigurere hvem en skal sendes til/fra, dette kunne f.eks. være til en mobiltelefon. RS-232, den serielle port i Pc en er softwarens kommunikations flade mod de andre enheder i systemer. Det er via denne port der kommunikeres via DoorGuard protokollen til de eksterne enheder. GuardTech databasen, det er her at programmet gemmer sine bruger informationer, opsætningen af enheder i systemet, og sin log. Der henvises til punkt 4 i dette dokument for yderligere informationer. Registrerings databasen i Windows 95, det er her at GuardTech programmet gemmer sine indstillinger, således at indstillinger lavet af brugeren ikke går tabt ved program stop Funktionel beskrivelse Programmet er lavet i 2 dele. En kommunikations thread og bruger fladen. Kommunikations thread en køre uafhængigt af resten af programmet, det er denne threads opgave at styre alt kommunikation til de andre enheder i systemet. Kommunikationen mellem denne thread og andre dele af programmet, foregår via funktions kald. Når andre dele af programmet skal overføre information til thread en så foregår det via globale variabler. Brugerfladen er event styret, dette vil sige at den står og laver ingenting, når Windows 95 så sender en message om at der har været trykket på en knap, eller hvad brugeren ellers kunne finde på, så vil programmet udføre funktionen tilknyttet denne message. Windows 95 Events Comm_Thread Globale Variabler Brugerflade GuardTech Projekt 4

5 2.3. Program oversigt Nedenstående diagram giver en oversigt over hvordan de enkelte moduler i programmet kommunikere. Der er kun beskrevet de funktioner som har kontakt med eksterne grænseflader, og de moduler som er en del af kommunikations vejen for at nå denne grænseflade. For yderligere informationer omkring disse og andre moduler i softwaren henvises til modul specifikationen. RS-232 Seriel port CGuardUsersRecordSet GuardTech Database Kommunikations Thread CGuardUnitsRecordSet CLogAsc CLogCountT otal CGuardLogRecordSet CGuardTechRegDb Class Bruger fladen CGuardTech Registrerings database Windows 95 Operatør Internettet ( ) 3.1. Eksterne grænseflader 3. Grænseflader RS-232 Seriel port Alt kommunikation med den serielle port, foregår gennem Classen CGuardTechSerial som er skrevet til dette, de kan findes yderligere informationer omkring denne class i modul specifikationen punkt Registrerings databasen i Windows 95 Alt brug af registrerings databasen, foregår gennem Classen CGuardTechRegDb som er skrevet til dette, de kan findes yderligere informationer omkring denne class i modul specifikationen punkt GuardTech Projekt 5

6 Internettet ( ) Alt kommunikation med Internettet, foregår gennem Classen CGuardTech som er skrevet til dette, de kan findes yderligere informationer omkring denne class i modul specifikationen punkt Operatør Brugerfladen i softwaren er event styret, der henvises til bruger manualen for yderligere informationer omkring betjening af softwaren, samt til punkt 2.2 i dette dokument for yderligere informationer omkring windows events GuardTech Database Alt kommunikation med databasen foregår gennem 3 class es, en som styre hver sin del af databasen, det vil sige bruger administration/validering styres af en class, konfiguration af enheder i systemet styres af en anden class, den sidste class tager sig af loggen i systemet. Der henvises til punkt 3.1/3.8/3.9 i modul specifikationen samt punkt 4 i dette dokument for yderligere informationer Interne grænseflader Programmet har 2 dele som kommunikere via globale variabler. (se eventuelt punkt 2.2) Der er 6 globale variabler som er beskrevet herunder, med navn, type, og mulige værdier. Navn.: Type.: Mulige værdier. m_bthreadrunning Varablen sættes til TRUE af thread en når den startes, og derefter er det resten af programmet der kan stoppe thread en ved at sætte den til FALSE. volatile BOOL True Hvis processen er startet. False For at stoppe thread en. m_bthreadstillrunning Varablen må kun ændres af thread en, og bruges af resten af programmet til at se om thread en køre. volatile BOOL True Thread en køre False Thread en er stoppet eller ikke startet endnu m_bunitconfig Denne variabel bruges af enheds konfigurationen til at indikere overfor thread en at der er sket ændringer i enheds opsætningen, derefter geninlæser thread en opsætningen. volatile BOOL True Der er sket ændringer af enheds konfigurationen. False Der er ikke sket nogle ændringer i enheds konfigurationen. KillSiren Denne variabel bruges til at stoppe sirenen/ holde den stoppet. volatile BOOL True Stop sirenen. False Så kan sirenen starte igen. m_balarmstat Denne variabel kan tilskrives fra hele programmet og bruges til at aktivere/deaktivere alarm systemet. volatile BOOL True Alarmsystemet er aktivt False Alarmsystemet er deaktiveret. SirenTest Denne variabel bruges til at teste sirenen, og dørenheden, variablen kan tilskrives fra hele programmet. Volatile int 0x00 Der skal ikke udføres nogle tests. 0xff Sirenen skal testes. 0x55 Dør enhederne skal testes. GuardTech Projekt 6

7 4.1. Databasen 4. GuardTech Databasen GuardTech databasen er en Access database, som GuardTech server programmet bruger til at gemme informationer i. Kommunikationen med databasen foregår gennem en ODBC forbindelse Tabeller Tabellen Log Denne tabel indeholder systemets log. Navn Type Beskrivelse ID AutoNumber Unikt post nummer Time Date/Time Tidspunkt for hændelsen EventText Text (255 tegn) Teksten der beskriver hændelsen UserName Text (40 tegn) Navnet på brugeren der forsagede hændelsen UnitID Number (Byte) ID et på den enhed der forsagede hændelsen BusID Number (Byte) Adressen på den enhed der forsagede hændelsen Tabellen Units Denne tabel indholder opsætningen af enheder i systemet. Navn Type Beskrivelse ID AutoNumber Unikt post nummer UnitID Number (Byte) Hvilken type enhed BusID Number (Byte) Enhedens adresse på den serielle bus Disabled Yes/No Er enheden disabled Tabellen Users Denne tabel indeholder opsætningen af brugere i systemet Navn Type Beskrivelse ID AutoNumber Unikt post nummer UserName Text (40 tegn) Brugrens navn PINCode Number (int) Brugrens PIN kode (krypteret) PINRequired Yes/No Skal brugeren bruge PIN kode Disablen Yes/No Er brugeren disabled 4.3. Forespørgsler Forespørgselen LogAsc Denne SQL forespørgsel bruges som adgang til loggen i systemet, og retunere hele loggen sorteret efter tid. SQL udtryk.: SELECT Log.Time, Log.EventText, Log.UserName, Log.UnitID, Log.BusID FROM Log ORDER BY Log.Time DESC; Forespørgselen LogCountTotal Denne SQL forespørgsel retunere antallet af poster i loggen. GuardTech Projekt 7

8 SQL udtryk.: SELECT Count([ID]) AS Count FROM Log; Forespørgselen UnitsAsc Denne SQL forespørgsel bruges som adgang til enheds konfigurationen i systemet, og retunere hele tabellen sorteret efter enheds ID, og enhedens adresse på bussen. SQL udtryk.: SELECT Units.UnitID, Units.BusID, Units.Disabled FROM Units ORDER BY Units.UnitID, Units.BusID; Forespørgselen UsersAsc Denne SQL forespørgsel bruges som adgang til bruger konfigurationen i systemet, og retunere hele tabellen sorteret efter brugerens ID. SQL udtryk.: SELECT Users.ID, Users.UserName, Useres.PINCode, Users.PINRequired, Users.Disabled FROM Users ORDER BY Users.ID; 5.1. Fælles moduler CGuardTechRegDb 5. Processer Denne class bruges både af hoved programmet, og af kommunikations thread en som adgangs vej til Windows 95 registrerings databasen. Se eventuelt punkt i dette dokument for yderligere informationer CGuardUnitsRecordSet Denne class bruges både af hoved programmet, og af kommunikations thread en som adgangs vej til enheds konfigurationen i GuardTech databasen. Se eventuelt punkt i dette dokument for yderligere informationer CGuardUsersRecordSet Denne class bruges både af hoved programmet, og af kommunikations thread en som adgangs vej til den del af GuardTech databasen der indeholder bruger administrationen. Se eventuelt punkt i dette dokument for yderligere informationer Hoved program Selve programmet er CGuartTechApp classen som laver et objekt af CGuardTechDlg classen, det er dette objekt som køre som selve programmet. Der henvises til modul specifikationen for yderligere informationer Kommunikations thread Denne thread er funktionen Comm_Thread i CGuadTechDlg Class en startes ved program opstart, for yderligere informationer omkring denne thread henvises Modul specifikationen punkt GuardTech Projekt 8

9 6.1. Oversættelses-hardware 6. Oversættelse For at kunne compile programmet kræves følgende hardware. - Min. en PII 233MHz - Min. 32Mb RAM - Min. 1Gb HD 6.2. Oversættelses-software For at kunne compile programmet kræves følgende software og kilde filer. - Microsoft Visual C Kilde filer Filnavn Beskrivelse GuardLogRecordSet.cpp Class til at håndtere forskellige database funktionerne i log tabellen. GuardLogViewDlg.cpp Class til at vise loggen i en dialog boks. GuardTech.cpp Åbner hoved dialog boksen. GuardTechDlg.cpp Class til at vise hoved dialog boksen. Indeholder også protokollen til at kommunikere med de eksterne enheder. GuardTech .cpp Class til at sende advarsel med. GuardTechRegDb.cpp Class til at skrive/læse til/fra registry en. GuardTechSerial.cpp Class til at initialisere og sende/modtage data på seriel porten. GuardUnitsRecordSet.cpp Class til at håndtere forskellige database funktioner i units tabellen. GuardUsersRecordSet.cpp Class til at håndtere forskellige database funktioner i user tabellen. LogAsc.cpp Class til at hente data fra log tabellen. LogCountTotal.cpp Class til at hente data fra log tabellen. StdAfx.cpp Bliver brugt til at inkludere standard h filer. SystemConfigDlg.cpp Class til at vise/ændre i system configurationen med. UnitAddDlg.cpp Dialog til at tilføje enheder med. UnitConfigDlg.cpp Dialog til at editere i de forskellige enheder. UnitEditAccessDlg.cpp Dialog til at editere i adgang enheden. UnitEditLockDlg.cpp Dialog til at editere i låse enheden. UnitEditSensorDlg.cpp Dialog til at editere i føler enheden. UnitEditSirenDlg.cpp Dialog til at editere i alarm enheden. UserAddDlg.cpp Dialog til at tilføje brugere med. UserAdminDlg.cpp Dialog til at administrere brugere. UserEditDlg.cpp Dialog til at editere en bruger med H filer GuardLogRecordSet.h GuardLogViewDlg.h GuardTech.h GuardTechDlg.h GuardTech .h GuardTechRegDb.h GuardTechSerial.h GuardUnitsRecordSet.h GuardUsersRecordSet.h LogAsc.h LogCountTotal.h resource.h Header fil til GuardLogRecordSet.cpp. Header fil til GuardLogViewDlg.cpp. Header fil til GuardTech.cpp. Header fil til GuardTechDlg.cpp. Header fil til GuardTech .cpp. Header fil til GuardTechRegDb.cpp. Header fil til GuardTechSerial.cpp. Header fil til GuardUnitsRecordSet.cpp. Header fil til GuardUsersRecordSet.cpp. Header fil til LogAsc.cpp. Header fil til LogCountTotal.cpp. Header fil til GuardTech.rc. GuardTech Projekt 9

10 StdAfx.h SystemConfigDlg.h UnitAddDlg.h UnitConfigDlg.h UnitEditAccessDlg.h UnitEditLockDlg.h UnitEditSensorDlg.h UnitEditSirenDlg.h UserAddDlg.h UserAdminDlg.h UserEditDlg.h Header fil til StdAfx.cpp. Header fil til SystemConfigDlg.cpp. Header fil til UnitAddDlg.cpp. Header fil til UnitConfigDlg.cpp. Header fil til UnitEditAccessDlg.cpp. Header fil til UnitEditLockDlg.cpp. Header fil til UnitEditSensorDlg.cpp. Header fil til UnitEditSirenDlg.cpp. Header fil til UserAddDlg.cpp. Header fil til UserAdminDlg.cpp. Header fil til UserEditDlg.cpp Ressource filer Filnavn GuardTech.ico ico00001.ico ico00002.ico icon1.ico 6.3. Oversættelse Beskrivelse GuarTech ikonen. Warining ikon Info ikon Alarm ikon Hele projektet hentes ind i Visual C++ (min version 5.0), hvorefter der i menuen Build vælg Build GuatdTech.exe 6.4. Installation Der henvises til brugervejledningen for yderligere informationer omkring installation af softwaren. 7. Bilag Modul specifikation NS diagrammer over GuardLogRecordSet.cpp NS diagrammer over GuardLogViewDlg.cpp NS diagrammer over GuardTech.cpp NS diagrammer over GuardTechDlg.cpp NS diagrammer over GuardTech .cpp NS diagrammer over GuardTechRegDb.cpp NS diagrammer over GuardTechSerial.cpp NS diagrammer over GuardUnitsRecordSet.cpp NS diagrammer over GuardUsersRecordSet.cpp NS diagrammer over Logasc.cpp NS diagrammer over LogCountTotal.cpp NS diagrammer over UnitConfigDlg.cpp NS diagrammer over UnitEditLockDlg.cpp NS diagrammer over UnitEditSirenDlg.cpp NS diagrammer over UserAdminDlg.cpp GuardTech Projekt 10