<?xml version="1.0"?>
<doc>
    <assembly>
        <name>iIDservice</name>
    </assembly>
    <members>
        <member name="T:iIDservice.Controllers.DOC.GeneralDocController">
            <summary>
            General DOC functions
            </summary>
        </member>
        <member name="M:iIDservice.Controllers.DOC.GeneralDocController.SetTimeout(System.Int32)">
            <summary>
            Sets a new timeout value (in ms)
            </summary>
            <param name="value">new timeout value</param>
            <returns></returns>
        </member>
        <member name="M:iIDservice.Controllers.DOC.GeneralDocController.GetTimeout">
            <summary>
            Gets current configured timeout value (in ms)
            </summary>
            <returns></returns>
        </member>
        <member name="M:iIDservice.Controllers.DOC.GeneralDocController.PostInitialize">
            <summary>
            Opens the communication port
            </summary>
            <returns></returns>
        </member>
        <member name="M:iIDservice.Controllers.DOC.GeneralDocController.PostTerminate">
            <summary>
            Closes communication port
            </summary>
            <returns></returns>
        </member>
        <member name="M:iIDservice.Controllers.DOC.GeneralDocController.GetIsConnected">
            <summary>
            Gets status of communication interface
            </summary>
            <returns></returns>
        </member>
        <member name="M:iIDservice.Controllers.DOC.GeneralDocController.GetReaderID">
            <summary>
            Reads RFID reader ID information
            </summary>
            <returns></returns>
            <response code="200">Reader information read</response>
            <response code="404">Reader not found/available</response>
        </member>
        <member name="M:iIDservice.Controllers.DOC.GeneralDocController.GetIdentify">
            <summary>
            Searches for transponders near the antenna
            </summary>
            <returns></returns>
            <response code="200">scan success information</response>
            <response code="404">no transponder found</response>
        </member>
        <member name="M:iIDservice.Controllers.DOC.GeneralDocController.GetReadBytes(iIDservice.Models.ReadBytesParameters)">
            <summary>
            Reads memory contents of given transponder
            </summary>
            <param name="_readParams">read parameters</param>
            <returns></returns>
            <response code="200">memory contents</response>
            <response code="400">missing needed parameter</response>
            <response code="404">transponder not found</response>
            <remarks>
            Sample request:
            
                GET /api/iidservice/doc/GeneralDoc/ReadBytes?&amp;TagID=1122334455667788&amp;PageNum=3&amp;FromByte=0&amp;LengthBytes=16
            </remarks>
        </member>
        <member name="M:iIDservice.Controllers.DOC.GeneralDocController.PostWriteData(iIDservice.Models.WriteBytesParameters)">
            <summary>
            Writes memory contents into given transponder
            </summary>
            <param name="_writeParams">write parameters</param>
            <returns></returns>
            <response code="200">success</response>
            <response code="400">missing needed parameter</response>
            <response code="404">transponder not found</response>
            <remarks>
            Sample request:
            
                POST /api/iidservice/doc/GeneralDoc/WriteBytes?&amp;TagID=1122334455667788&amp;PageNum=3&amp;FromByte=0&amp;Data=30313233'
            </remarks>
        </member>
        <member name="M:iIDservice.Controllers.DOC.GeneralDocController.GetIdentifyCycleMillis(iIDservice.Models.CycleParameters)">
            <summary>
            SSE endpoint to cyclically scan for transponders
            </summary>
            <param name="_parameters">scan parameters</param>
            <returns></returns>
            <remarks>
            Sample request:
            
                SSE /api/iidservice/doc/GeneralDoc/IdentifyCycle
            </remarks>
        </member>
        <member name="T:iIDservice.Controllers.DOC.InterfaceDocController">
            <summary>
            Controller for SPC interface definition functionality
            </summary>
        </member>
        <member name="M:iIDservice.Controllers.DOC.InterfaceDocController.GetCurrentSettings">
            <summary>
            Returns current configured DOC interface settings
            </summary>
            <returns>JSON dictionary containing DOC interface settings</returns>
            <response code="200">currently configured DOC interface settings</response>
            <response code="404">interface settings not available</response>
        </member>
        <member name="M:iIDservice.Controllers.DOC.InterfaceDocController.PostCurrentSettings(iIDservice.Models.DocInterfaceParameters)">
            <summary>
            Defines new DOC interface settings
            </summary>
            <param name="input">new DOC interface settings</param>
            <returns>Operation result</returns>
            <response code="200">applied DOC interface settings</response>
            <response code="400">wrong interface settings set</response>
            <remarks>
            Sample request:
            
                POST /api/iidservice/doc/interface/CurrentSettings?&amp;PortName=COM1&amp;PortType=4&amp;InterfaceType=1356
            </remarks>
        </member>
        <member name="M:iIDservice.Controllers.DOC.InterfaceDocController.GetPossibleSettings">
            <summary>
            Gets possible values to use in POST CurrentSettings
            </summary>
            <returns></returns>
            <response code="200">possible values to use</response>
            <response code="404">error while obtaining possible values</response>
        </member>
        <member name="T:iIDservice.Controllers.DOC.TelidTransponderController">
            <summary>
            TELID® sensor transponder controller
            </summary>
        </member>
        <member name="M:iIDservice.Controllers.DOC.TelidTransponderController.GetSensorData">
            <summary>
            Scans for a TELID® sensor transponder and read measurement
            </summary>
            <returns></returns>
            <response code="200">sensor and measurement information</response>
            <response code="404">no sensor found</response>
            <remarks>
            Sample request:
            
                GET /api/iidservice/doc/TelidTransponder/GetSensorData
            </remarks>
        </member>
        <member name="M:iIDservice.Controllers.DOC.TelidTransponderController.GetSensorDataCycleMillis(iIDservice.Models.CycleParameters)">
            <summary>
            SSE for cyclically obtaining sensor values from TELID® sensor transponders
            </summary>
            <param name="_parameters">parameters for SSE</param>
            <returns></returns>
            <remarks>
            Sample request:
               
                SSE /api/iidservice/doc/GetSensorDataCycle
            </remarks>
        </member>
        <member name="T:iIDservice.Controllers.SPC.GeneralSpcController">
            <summary>
            General SPC functions
            </summary>
        </member>
        <member name="M:iIDservice.Controllers.SPC.GeneralSpcController.PostInitialize(iIDservice.Models.SpcProtocolParameters)">
            <summary>
            Opens the communication port
            </summary>
            <param name="_spcProtocolParams">parameters used in SPC communication</param>
            <returns></returns>
            <response code="200">success</response>
            <remarks>
            Sample request:
            
                POST /api/iidservice/spc/GeneralSpc/Initialize?&amp;SpcDataPrefix=:&amp;SpcDataSufix=@&amp;UseMssProtocol=false
            </remarks>
        </member>
        <member name="M:iIDservice.Controllers.SPC.GeneralSpcController.PostTerminate">
            <summary>
            Closes the communication port
            </summary>
            <returns></returns>
            <response code="200">success</response>
        </member>
        <member name="M:iIDservice.Controllers.SPC.GeneralSpcController.GetIsInitialized">
            <summary>
            Gets if connection is initialized
            </summary>
            <returns></returns>
            <response code="200">success</response>
        </member>
        <member name="M:iIDservice.Controllers.SPC.GeneralSpcController.GetLastHeartbeat">
            <summary>
            Obtains last heartbeat
            </summary>
            <returns></returns>
            <response code="200">last received heartbeat</response>
            <response code="404">no heartbeat received</response>
        </member>
        <member name="M:iIDservice.Controllers.SPC.GeneralSpcController.GetRawData">
            <summary>
            Obtains spc data
            </summary>
            <returns></returns>
            <response code="200">SPC data received</response>
            <response code="404">no SPC data received</response>
        </member>
        <member name="M:iIDservice.Controllers.SPC.GeneralSpcController.PostSendCommandASCII(System.String)">
            <summary>
            Send SPC request using text in ASCII
            </summary>
            <param name="Request">SPC request as text</param>
            <returns></returns>
            <response code="200">success</response>
            <remarks>
            Sample request:
            
                POST /api/iidservice/spc/GeneralSpc/SendSpcRequestASCII?&amp;Request=~T
            </remarks>
        </member>
        <member name="M:iIDservice.Controllers.SPC.GeneralSpcController.PostSendCommandHex(System.String)">
            <summary>
            Send SPC request using bytes in HEX
            </summary>
            <param name="RequestHex">SPC request in HEX</param>
            <returns></returns>
            <response code="200">success</response>
            <remarks>
            Sample request:
            
                POST /api/iidservice/spc/GeneralSpc/SendSpcRequestBytes?&amp;Request=46
            </remarks>
        </member>
        <member name="M:iIDservice.Controllers.SPC.GeneralSpcController.GetReceiveData(iIDservice.Models.SpcReceiveParameters)">
            <summary>
            SSE endpoint to receive SPC updates
            </summary>
            <param name="_receiveParams">parameters for SSE</param>
            <returns></returns>
            <remarks>
            Sample request:
            
                SSE /api/iidservice/spc/GeneralSpc/ReceiveUpdates
            </remarks>
        </member>
        <member name="T:iIDservice.Controllers.SPC.InterfaceSpcController">
            <summary>
            Controller for SPC interface definition functionality
            </summary>
        </member>
        <member name="M:iIDservice.Controllers.SPC.InterfaceSpcController.GetCurrentSettings">
            <summary>
            Returns current configured SPC interface settings
            </summary>
            <returns>JSON dictionary containing SPC interface settings</returns>
            <response code="200">currently configured SPC interface settings</response>
            <response code="404">interface settings not available</response>
        </member>
        <member name="M:iIDservice.Controllers.SPC.InterfaceSpcController.PostCurrentSettings(iIDservice.Models.SpcInterfaceParameters)">
            <summary>
            Defines new SPC interface settings
            </summary>
            <param name="input">new SPC interface settings</param>
            <returns>Operation result</returns>
            <response code="200">applied SPC interface settings</response>
            <response code="400">wrong interface settings set</response>
            <remarks>
            Sample request:
            
                POST /api/iidservice/spc/interface/CurrentSettings?&amp;PortName=COM3&amp;PortType=2
            </remarks>
        </member>
        <member name="M:iIDservice.Controllers.SPC.InterfaceSpcController.GetPossibleSettings">
            <summary>
            Gets possible values to use in POST CurrentSettings
            </summary>
            <returns></returns>
            <response code="200">possible values to use</response>
            <response code="404">error while obtaining possible values</response>
        </member>
        <member name="T:iIDservice.Controllers.VersionController">
            <summary>
            Controller for Version information
            </summary>
        </member>
        <member name="M:iIDservice.Controllers.VersionController.GetVersion">
            <summary>
            Obtains the version information
            </summary>
            <returns>JSON dictionary with version information</returns>
            <response code="200">Returns the version information</response>
        </member>
        <member name="T:iIDservice.Helpers.Tracer.Log_Type">
            <summary>
            Enum With INFORMATION, WARNING, ERROR, CRITICAL
            </summary>
        </member>
        <member name="M:iIDservice.Helpers.Tracer.LogMessage(iIDservice.Helpers.Tracer.Log_Type,System.String)">
            <summary>
            save logging message in file 
            </summary>
            <param name="log_Type">logging type information from enum</param>
            <param name="_toLog">logging message</param>
        </member>
        <member name="T:iIDservice.Models.CycleParameters">
            <summary>
            Parameters for cyclically scans
            </summary>
        </member>
        <member name="P:iIDservice.Models.CycleParameters.IntervalMs">
            <summary>
            Interval between scans
            </summary>
        </member>
        <member name="P:iIDservice.Models.CycleParameters.NumTries">
            <summary>
            Maximum number of tries (sucessfull or failed)
            </summary>
        </member>
        <member name="T:iIDservice.Models.DocInterfaceParameters">
            <summary>
            DOC interface parameters
            </summary>
        </member>
        <member name="P:iIDservice.Models.DocInterfaceParameters.PortName">
            <summary>
            Port name
            </summary>
        </member>
        <member name="P:iIDservice.Models.DocInterfaceParameters.PortType">
            <summary>
            Port type number (0 = Serial, 2 = Bluetooth, 4 = USB)
            </summary>
        </member>
        <member name="P:iIDservice.Models.DocInterfaceParameters.InterfaceType">
            <summary>
            Interface type number (1356 = HF, 868 = UHF)
            </summary>
        </member>
        <member name="P:iIDservice.Models.DocInterfaceParameters.ProtocolType">
            <summary>
            Protocol type number (3 = 3000pro, 4 = v4)
            </summary>
        </member>
        <member name="P:iIDservice.Models.ReadBytesParameters.TagID">
            <summary>
            ID of transponder to read
            </summary>
        </member>
        <member name="P:iIDservice.Models.ReadBytesParameters.PageNum">
            <summary>
            Page or segment number to read
            </summary>
        </member>
        <member name="P:iIDservice.Models.ReadBytesParameters.FromByte">
            <summary>
            First byte to read
            </summary>
        </member>
        <member name="P:iIDservice.Models.ReadBytesParameters.LengthBytes">
            <summary>
            Number of bytes to read
            </summary>
        </member>
        <member name="P:iIDservice.Models.ReadBytesResult.TagID">
            <summary>
            ID of transponder 
            </summary>
        </member>
        <member name="P:iIDservice.Models.ReadBytesResult.PageNum">
            <summary>
            Page or segment number 
            </summary>
        </member>
        <member name="P:iIDservice.Models.ReadBytesResult.FromByte">
            <summary>
            First byte
            </summary>
        </member>
        <member name="P:iIDservice.Models.ReadBytesResult.LengthBytes">
            <summary>
            Number of bytes
            </summary>
        </member>
        <member name="P:iIDservice.Models.ReadBytesResult.Data">
            <summary>
            Data read
            </summary>
        </member>
        <member name="P:iIDservice.Models.SpcHeartbeatResult.Timestamp">
            <summary>
            Timestamp when the heartbeat was received
            </summary>
        </member>
        <member name="P:iIDservice.Models.SpcHeartbeatResult.ReaderID">
            <summary>
            Reader ID number
            </summary>
        </member>
        <member name="P:iIDservice.Models.SpcHeartbeatResult.BatteryStatus">
            <summary>
            Reader battery status (if available)
            </summary>
        </member>
        <member name="P:iIDservice.Models.SpcHeartbeatResult.ScriptName">
            <summary>
            Name of the script running on the RFID reader (if available, only possible if using iID® protocol instead of custom protocol)
            </summary>
        </member>
        <member name="T:iIDservice.Models.SpcInterfaceParameters">
            <summary>
            SPC interface parameters
            </summary>
        </member>
        <member name="P:iIDservice.Models.SpcInterfaceParameters.PortName">
            <summary>
            Port name
            </summary>
        </member>
        <member name="P:iIDservice.Models.SpcInterfaceParameters.PortType">
            <summary>
            Port type number (0 = Serial, 2 = Bluetooth, 4 = USB)
            </summary>
        </member>
        <member name="T:iIDservice.Models.SpcProtocolParameters">
            <summary>
            Protocol parameters for SPC 
            </summary>
        </member>
        <member name="P:iIDservice.Models.SpcProtocolParameters.SpcDataPrefix">
            <summary>
            SPC prefix
            </summary>
        </member>
        <member name="P:iIDservice.Models.SpcProtocolParameters.SpcDataSufix">
            <summary>
            SPC suffix
            </summary>
        </member>
        <member name="P:iIDservice.Models.SpcProtocolParameters.UseMssProtocol">
            <summary>
            Plain/text or protocol
            </summary>
        </member>
        <member name="T:iIDservice.Models.SpcReceiveParameters">
            <summary>
            Parameters for SPC receive loop
            </summary>
        </member>
        <member name="P:iIDservice.Models.SpcReceiveParameters.HeartbeatTimeoutMs">
            <summary>
            Timeout for new heartbeat report (in ms)
            </summary>
        </member>
        <member name="P:iIDservice.Models.SpcReceiveParameters.UpdateReportIntervalMs">
            <summary>
            Interval to report data (in ms)
            </summary>
        </member>
        <member name="T:iIDservice.Models.WriteBytesParameters">
            <summary>
            Parameters for write operation
            </summary>
        </member>
        <member name="P:iIDservice.Models.WriteBytesParameters.TagID">
            <summary>
            Transponder ID to write memory contents
            </summary>
        </member>
        <member name="P:iIDservice.Models.WriteBytesParameters.PageNum">
            <summary>
            Page/Segment number
            </summary>
        </member>
        <member name="P:iIDservice.Models.WriteBytesParameters.FromByte">
            <summary>
            First byte to write
            </summary>
        </member>
        <member name="P:iIDservice.Models.WriteBytesParameters.Data">
            <summary>
            Data to write 
            </summary>
        </member>
        <member name="P:iIDservice.Models.WriteBytesResult.TagID">
            <summary>
            Transponder ID 
            </summary>
        </member>
        <member name="P:iIDservice.Models.WriteBytesResult.PageNum">
            <summary>
            Page/Segment number
            </summary>
        </member>
        <member name="P:iIDservice.Models.WriteBytesResult.FromByte">
            <summary>
            First byte 
            </summary>
        </member>
        <member name="P:iIDservice.Models.WriteBytesResult.Data">
            <summary>
            Data written
            </summary>
        </member>
    </members>
</doc>
