1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>S7.Net</name>
- </assembly>
- <members>
- <member name="T:S7.Net.Conversion">
- <summary>
- Conversion methods to convert from Siemens numeric format to C# and back
- </summary>
- </member>
- <member name="M:S7.Net.Conversion.BinStringToInt32(System.String)">
- <summary>
- Converts a binary string to Int32 value
- </summary>
- <param name="txt"></param>
- <returns></returns>
- </member>
- <member name="M:S7.Net.Conversion.BinStringToByte(System.String)">
- <summary>
- Converts a binary string to a byte. Can return null.
- </summary>
- <param name="txt"></param>
- <returns></returns>
- </member>
- <member name="M:S7.Net.Conversion.ValToBinString(System.Object)">
- <summary>
- Converts the value to a binary string
- </summary>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:S7.Net.Conversion.SelectBit(System.Byte,System.Int32)">
- <summary>
- Helper to get a bit value given a byte and the bit index.
- <br/>
- <example>
- Get the bit at DB1.DBX0.5:
- <code>
- byte data = ReadByte("DB1.DBB0");
- bool bit = data.SelectBit(5);
- </code>
- </example>
- </summary>
- <param name="data">The data to get from.</param>
- <param name="index">The zero-based index of the bit to get.</param>
- <returns>The Boolean value will get.</returns>
- </member>
- <member name="M:S7.Net.Conversion.SetBit(System.Byte@,System.Int32,System.Boolean)">
- <summary>
- Helper to set a bit value to the given byte at the bit index.
- <br/>
- <example>
- Set the bit at index 4:
- <code>
- byte data = 0;
- data.SetBit(4, true);
- </code>
- </example>
- </summary>
- <param name="data">The data to be modified.</param>
- <param name="index">The zero-based index of the bit to set.</param>
- <param name="value">The Boolean value to assign to the bit.</param>
- </member>
- <member name="M:S7.Net.Conversion.ConvertToShort(System.UInt16)">
- <summary>
- Converts from ushort value to short value; it's used to retrieve negative values from words
- </summary>
- <param name="input"></param>
- <returns></returns>
- </member>
- <member name="M:S7.Net.Conversion.ConvertToUshort(System.Int16)">
- <summary>
- Converts from short value to ushort value; it's used to pass negative values to DWs
- </summary>
- <param name="input"></param>
- <returns></returns>
- </member>
- <member name="M:S7.Net.Conversion.ConvertToInt(System.UInt32)">
- <summary>
- Converts from UInt32 value to Int32 value; it's used to retrieve negative values from DBDs
- </summary>
- <param name="input"></param>
- <returns></returns>
- </member>
- <member name="M:S7.Net.Conversion.ConvertToUInt(System.Int32)">
- <summary>
- Converts from Int32 value to UInt32 value; it's used to pass negative values to DBDs
- </summary>
- <param name="input"></param>
- <returns></returns>
- </member>
- <member name="M:S7.Net.Conversion.ConvertToUInt(System.Single)">
- <summary>
- Converts from float to DWord (DBD)
- </summary>
- <param name="input"></param>
- <returns></returns>
- </member>
- <member name="M:S7.Net.Conversion.ConvertToFloat(System.UInt32)">
- <summary>
- Converts from DWord (DBD) to float
- </summary>
- <param name="input"></param>
- <returns></returns>
- </member>
- <member name="T:S7.Net.COTP">
- <summary>
- COTP Protocol functions and types
- </summary>
- </member>
- <member name="T:S7.Net.COTP.TPDU">
- <summary>
- Describes a COTP TPDU (Transport protocol data unit)
- </summary>
- </member>
- <member name="M:S7.Net.COTP.TPDU.ReadAsync(System.IO.Stream,System.Threading.CancellationToken)">
- <summary>
- Reads COTP TPDU (Transport protocol data unit) from the network stream
- See: https://tools.ietf.org/html/rfc905
- </summary>
- <param name="stream">The socket to read from</param>
- <param name="cancellationToken">A cancellation token that can be used to cancel the asynchronous operation.</param>
- <returns>COTP DPDU instance</returns>
- </member>
- <member name="T:S7.Net.COTP.TSDU">
- <summary>
- Describes a COTP TSDU (Transport service data unit). One TSDU consist of 1 ore more TPDUs
- </summary>
- </member>
- <member name="M:S7.Net.COTP.TSDU.ReadAsync(System.IO.Stream,System.Threading.CancellationToken)">
- <summary>
- Reads the full COTP TSDU (Transport service data unit)
- See: https://tools.ietf.org/html/rfc905
- </summary>
- <param name="stream">The stream to read from</param>
- <param name="cancellationToken">A cancellation token that can be used to cancel the asynchronous operation.</param>
- <returns>Data in TSDU</returns>
- </member>
- <member name="T:S7.Net.CpuType">
- <summary>
- Types of S7 cpu supported by the library
- </summary>
- </member>
- <member name="F:S7.Net.CpuType.S7200">
- <summary>
- S7 200 cpu type
- </summary>
- </member>
- <member name="F:S7.Net.CpuType.Logo0BA8">
- <summary>
- Siemens Logo 0BA8
- </summary>
- </member>
- <member name="F:S7.Net.CpuType.S7200Smart">
- <summary>
- S7 200 Smart
- </summary>
- </member>
- <member name="F:S7.Net.CpuType.S7300">
- <summary>
- S7 300 cpu type
- </summary>
- </member>
- <member name="F:S7.Net.CpuType.S7400">
- <summary>
- S7 400 cpu type
- </summary>
- </member>
- <member name="F:S7.Net.CpuType.S71200">
- <summary>
- S7 1200 cpu type
- </summary>
- </member>
- <member name="F:S7.Net.CpuType.S71500">
- <summary>
- S7 1500 cpu type
- </summary>
- </member>
- <member name="T:S7.Net.ErrorCode">
- <summary>
- Types of error code that can be set after a function is called
- </summary>
- </member>
- <member name="F:S7.Net.ErrorCode.NoError">
- <summary>
- The function has been executed correctly
- </summary>
- </member>
- <member name="F:S7.Net.ErrorCode.WrongCPU_Type">
- <summary>
- Wrong type of CPU error
- </summary>
- </member>
- <member name="F:S7.Net.ErrorCode.ConnectionError">
- <summary>
- Connection error
- </summary>
- </member>
- <member name="F:S7.Net.ErrorCode.IPAddressNotAvailable">
- <summary>
- Ip address not available
- </summary>
- </member>
- <member name="F:S7.Net.ErrorCode.WrongVarFormat">
- <summary>
- Wrong format of the variable
- </summary>
- </member>
- <member name="F:S7.Net.ErrorCode.WrongNumberReceivedBytes">
- <summary>
- Wrong number of received bytes
- </summary>
- </member>
- <member name="F:S7.Net.ErrorCode.SendData">
- <summary>
- Error on send data
- </summary>
- </member>
- <member name="F:S7.Net.ErrorCode.ReadData">
- <summary>
- Error on read data
- </summary>
- </member>
- <member name="F:S7.Net.ErrorCode.WriteData">
- <summary>
- Error on write data
- </summary>
- </member>
- <member name="T:S7.Net.DataType">
- <summary>
- Types of memory area that can be read
- </summary>
- </member>
- <member name="F:S7.Net.DataType.Input">
- <summary>
- Input area memory
- </summary>
- </member>
- <member name="F:S7.Net.DataType.Output">
- <summary>
- Output area memory
- </summary>
- </member>
- <member name="F:S7.Net.DataType.Memory">
- <summary>
- Merkers area memory (M0, M0.0, ...)
- </summary>
- </member>
- <member name="F:S7.Net.DataType.DataBlock">
- <summary>
- DB area memory (DB1, DB2, ...)
- </summary>
- </member>
- <member name="F:S7.Net.DataType.Timer">
- <summary>
- Timer area memory(T1, T2, ...)
- </summary>
- </member>
- <member name="F:S7.Net.DataType.Counter">
- <summary>
- Counter area memory (C1, C2, ...)
- </summary>
- </member>
- <member name="T:S7.Net.VarType">
- <summary>
- Types
- </summary>
- </member>
- <member name="F:S7.Net.VarType.Bit">
- <summary>
- S7 Bit variable type (bool)
- </summary>
- </member>
- <member name="F:S7.Net.VarType.Byte">
- <summary>
- S7 Byte variable type (8 bits)
- </summary>
- </member>
- <member name="F:S7.Net.VarType.Word">
- <summary>
- S7 Word variable type (16 bits, 2 bytes)
- </summary>
- </member>
- <member name="F:S7.Net.VarType.DWord">
- <summary>
- S7 DWord variable type (32 bits, 4 bytes)
- </summary>
- </member>
- <member name="F:S7.Net.VarType.Int">
- <summary>
- S7 Int variable type (16 bits, 2 bytes)
- </summary>
- </member>
- <member name="F:S7.Net.VarType.DInt">
- <summary>
- DInt variable type (32 bits, 4 bytes)
- </summary>
- </member>
- <member name="F:S7.Net.VarType.Real">
- <summary>
- Real variable type (32 bits, 4 bytes)
- </summary>
- </member>
- <member name="F:S7.Net.VarType.LReal">
- <summary>
- LReal variable type (64 bits, 8 bytes)
- </summary>
- </member>
- <member name="F:S7.Net.VarType.String">
- <summary>
- Char Array / C-String variable type (variable)
- </summary>
- </member>
- <member name="F:S7.Net.VarType.S7String">
- <summary>
- S7 String variable type (variable)
- </summary>
- </member>
- <member name="F:S7.Net.VarType.S7WString">
- <summary>
- S7 WString variable type (variable)
- </summary>
- </member>
- <member name="F:S7.Net.VarType.Timer">
- <summary>
- Timer variable type
- </summary>
- </member>
- <member name="F:S7.Net.VarType.Counter">
- <summary>
- Counter variable type
- </summary>
- </member>
- <member name="F:S7.Net.VarType.DateTime">
- <summary>
- DateTIme variable type
- </summary>
- </member>
- <member name="F:S7.Net.VarType.Date">
- <summary>
- IEC date (legacy) variable type
- </summary>
- </member>
- <member name="F:S7.Net.VarType.DateTimeLong">
- <summary>
- DateTimeLong variable type
- </summary>
- </member>
- <member name="F:S7.Net.VarType.Time">
- <summary>
- S7 TIME variable type - serialized as S7 DInt and deserialized as C# TimeSpan
- </summary>
- </member>
- <member name="M:S7.Net.Helper.MemoryStreamExtension.Write(System.IO.MemoryStream,System.Byte[])">
- <summary>
- Helper function to write to whole content of the given byte array to a memory stream.
-
- Writes all bytes in value from 0 to value.Length to the memory stream.
- </summary>
- <param name="stream"></param>
- <param name="value"></param>
- </member>
- <member name="M:S7.Net.Helper.MemoryStreamExtension.Write(System.IO.MemoryStream,System.ReadOnlySpan{System.Byte})">
- <summary>
- Helper function to write the whole content of the given byte span to a memory stream.
- </summary>
- <param name="stream"></param>
- <param name="value"></param>
- </member>
- <member name="T:S7.Net.Plc">
- <summary>
- Creates an instance of S7.Net driver
- </summary>
- <summary>
- Creates an instance of S7.Net driver
- </summary>
- </member>
- <member name="F:S7.Net.Plc.DateTimeLength">
- <summary>
- The length in bytes of DateTime stored in the PLC.
- </summary>
- </member>
- <member name="F:S7.Net.Plc.DefaultPort">
- <summary>
- The default port for the S7 protocol.
- </summary>
- </member>
- <member name="F:S7.Net.Plc.DefaultTimeout">
- <summary>
- The default timeout (in milliseconds) used for <see cref="P:ReadTimeout"/> and <see cref="P:WriteTimeout"/>.
- </summary>
- </member>
- <member name="P:S7.Net.Plc.IP">
- <summary>
- IP address of the PLC
- </summary>
- </member>
- <member name="P:S7.Net.Plc.Port">
- <summary>
- PORT Number of the PLC, default is 102
- </summary>
- </member>
- <member name="P:S7.Net.Plc.TsapPair">
- <summary>
- The TSAP addresses used during the connection request.
- </summary>
- </member>
- <member name="P:S7.Net.Plc.CPU">
- <summary>
- CPU type of the PLC
- </summary>
- </member>
- <member name="P:S7.Net.Plc.Rack">
- <summary>
- Rack of the PLC
- </summary>
- </member>
- <member name="P:S7.Net.Plc.Slot">
- <summary>
- Slot of the CPU of the PLC
- </summary>
- </member>
- <member name="P:S7.Net.Plc.MaxPDUSize">
- <summary>
- Max PDU size this cpu supports
- </summary>
- </member>
- <member name="P:S7.Net.Plc.ReadTimeout">
- <summary>Gets or sets the amount of time that a read operation blocks waiting for data from PLC.</summary>
- <returns>A <see cref="T:System.Int32" /> that specifies the amount of time, in milliseconds, that will elapse before a read operation fails. The default value, <see cref="F:System.Threading.Timeout.Infinite" />, specifies that the read operation does not time out.</returns>
- </member>
- <member name="P:S7.Net.Plc.WriteTimeout">
- <summary>Gets or sets the amount of time that a write operation blocks waiting for data to PLC. </summary>
- <returns>A <see cref="T:System.Int32" /> that specifies the amount of time, in milliseconds, that will elapse before a write operation fails. The default value, <see cref="F:System.Threading.Timeout.Infinite" />, specifies that the write operation does not time out.</returns>
- </member>
- <member name="P:S7.Net.Plc.IsConnected">
- <summary>
- Gets a value indicating whether a connection to the PLC has been established.
- </summary>
- <remarks>
- The <see cref="P:S7.Net.Plc.IsConnected"/> property gets the connection state of the Client socket as
- of the last I/O operation. When it returns <c>false</c>, the Client socket was either
- never connected, or is no longer connected.
-
- <para>
- Because the <see cref="P:S7.Net.Plc.IsConnected"/> property only reflects the state of the connection
- as of the most recent operation, you should attempt to send or receive a message to
- determine the current state. After the message send fails, this property no longer
- returns <c>true</c>. Note that this behavior is by design. You cannot reliably test the
- state of the connection because, in the time between the test and a send/receive, the
- connection could have been lost. Your code should assume the socket is connected, and
- gracefully handle failed transmissions.
- </para>
- </remarks>
- </member>
- <member name="M:S7.Net.Plc.#ctor(S7.Net.CpuType,System.String,System.Int16,System.Int16)">
- <summary>
- Creates a PLC object with all the parameters needed for connections.
- For S7-1200 and S7-1500, the default is rack = 0 and slot = 0.
- You need slot > 0 if you are connecting to external ethernet card (CP).
- For S7-300 and S7-400 the default is rack = 0 and slot = 2.
- </summary>
- <param name="cpu">CpuType of the PLC (select from the enum)</param>
- <param name="ip">Ip address of the PLC</param>
- <param name="rack">rack of the PLC, usually it's 0, but check in the hardware configuration of Step7 or TIA portal</param>
- <param name="slot">slot of the CPU of the PLC, usually it's 2 for S7300-S7400, 0 for S7-1200 and S7-1500.
- If you use an external ethernet card, this must be set accordingly.</param>
- </member>
- <member name="M:S7.Net.Plc.#ctor(S7.Net.CpuType,System.String,System.Int32,System.Int16,System.Int16)">
- <summary>
- Creates a PLC object with all the parameters needed for connections.
- For S7-1200 and S7-1500, the default is rack = 0 and slot = 0.
- You need slot > 0 if you are connecting to external ethernet card (CP).
- For S7-300 and S7-400 the default is rack = 0 and slot = 2.
- </summary>
- <param name="cpu">CpuType of the PLC (select from the enum)</param>
- <param name="ip">Ip address of the PLC</param>
- <param name="port">Port number used for the connection, default 102.</param>
- <param name="rack">rack of the PLC, usually it's 0, but check in the hardware configuration of Step7 or TIA portal</param>
- <param name="slot">slot of the CPU of the PLC, usually it's 2 for S7300-S7400, 0 for S7-1200 and S7-1500.
- If you use an external ethernet card, this must be set accordingly.</param>
- </member>
- <member name="M:S7.Net.Plc.#ctor(System.String,S7.Net.Protocol.TsapPair)">
- <summary>
- Creates a PLC object with all the parameters needed for connections.
- For S7-1200 and S7-1500, the default is rack = 0 and slot = 0.
- You need slot > 0 if you are connecting to external ethernet card (CP).
- For S7-300 and S7-400 the default is rack = 0 and slot = 2.
- </summary>
- <param name="ip">Ip address of the PLC</param>
- <param name="tsapPair">The TSAP addresses used for the connection request.</param>
- </member>
- <member name="M:S7.Net.Plc.#ctor(System.String,System.Int32,S7.Net.Protocol.TsapPair)">
- <summary>
- Creates a PLC object with all the parameters needed for connections. Use this constructor
- if you want to manually override the TSAP addresses used during the connection request.
- </summary>
- <param name="ip">Ip address of the PLC</param>
- <param name="port">Port number used for the connection, default 102.</param>
- <param name="tsapPair">The TSAP addresses used for the connection request.</param>
- </member>
- <member name="M:S7.Net.Plc.Close">
- <summary>
- Close connection to PLC
- </summary>
- </member>
- <member name="M:S7.Net.Plc.Dispose(System.Boolean)">
- <summary>
- Dispose Plc Object
- </summary>
- <param name="disposing"></param>
- </member>
- <member name="M:S7.Net.Plc.OpenAsync(System.Threading.CancellationToken)">
- <summary>
- Connects to the PLC and performs a COTP ConnectionRequest and S7 CommunicationSetup.
- </summary>
- <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- Please note that the cancellation will not affect opening the socket in any way and only affects data transfers for configuring the connection after the socket connection is successfully established.
- Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- <returns>A task that represents the asynchronous open operation.</returns>
- </member>
- <member name="M:S7.Net.Plc.ReadBytesAsync(S7.Net.DataType,System.Int32,System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Reads a number of bytes from a DB starting from a specified index. This handles more than 200 bytes with multiple requests.
- If the read was not successful, check LastErrorCode or LastErrorString.
- </summary>
- <param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
- <param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
- <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- <param name="count">Byte count, if you want to read 120 bytes, set this to 120.</param>
- <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- <returns>Returns the bytes in an array</returns>
- </member>
- <member name="M:S7.Net.Plc.ReadBytesAsync(System.Memory{System.Byte},S7.Net.DataType,System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Reads a number of bytes from a DB starting from a specified index. This handles more than 200 bytes with multiple requests.
- If the read was not successful, check LastErrorCode or LastErrorString.
- </summary>
- <param name="buffer">Buffer to receive the read bytes. The <see cref="P:System.Memory`1.Length"/> determines the number of bytes to read.</param>
- <param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
- <param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
- <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- <returns>Returns the bytes in an array</returns>
- </member>
- <member name="M:S7.Net.Plc.ReadAsync(S7.Net.DataType,System.Int32,System.Int32,S7.Net.VarType,System.Int32,System.Byte,System.Threading.CancellationToken)">
- <summary>
- Read and decode a certain number of bytes of the "VarType" provided.
- This can be used to read multiple consecutive variables of the same type (Word, DWord, Int, etc).
- If the read was not successful, check LastErrorCode or LastErrorString.
- </summary>
- <param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
- <param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
- <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- <param name="varType">Type of the variable/s that you are reading</param>
- <param name="bitAdr">Address of bit. If you want to read DB1.DBX200.6, set 6 to this parameter.</param>
- <param name="varCount"></param>
- <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- </member>
- <member name="M:S7.Net.Plc.ReadAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Reads a single variable from the PLC, takes in input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.
- If the read was not successful, check LastErrorCode or LastErrorString.
- </summary>
- <param name="variable">Input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.</param>
- <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- <returns>Returns an object that contains the value. This object must be cast accordingly.</returns>
- </member>
- <member name="M:S7.Net.Plc.ReadStructAsync(System.Type,System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Reads all the bytes needed to fill a struct in C#, starting from a certain address, and return an object that can be casted to the struct.
- </summary>
- <param name="structType">Type of the struct to be readed (es.: TypeOf(MyStruct)).</param>
- <param name="db">Address of the DB.</param>
- <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- <returns>Returns a struct that must be cast.</returns>
- </member>
- <member name="M:S7.Net.Plc.ReadStructAsync``1(System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Reads all the bytes needed to fill a struct in C#, starting from a certain address, and returns the struct or null if nothing was read.
- </summary>
- <typeparam name="T">The struct type</typeparam>
- <param name="db">Address of the DB.</param>
- <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- <returns>Returns a nulable struct. If nothing was read null will be returned.</returns>
- </member>
- <member name="M:S7.Net.Plc.ReadClassAsync(System.Object,System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Reads all the bytes needed to fill a class in C#, starting from a certain address, and set all the properties values to the value that are read from the PLC.
- This reads only properties, it doesn't read private variable or public variable without {get;set;} specified.
- </summary>
- <param name="sourceClass">Instance of the class that will store the values</param>
- <param name="db">Index of the DB; es.: 1 is for DB1</param>
- <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- <returns>The number of read bytes</returns>
- </member>
- <member name="M:S7.Net.Plc.ReadClassAsync``1(System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Reads all the bytes needed to fill a class in C#, starting from a certain address, and set all the properties values to the value that are read from the PLC.
- This reads only properties, it doesn't read private variable or public variable without {get;set;} specified. To instantiate the class defined by the generic
- type, the class needs a default constructor.
- </summary>
- <typeparam name="T">The class that will be instantiated. Requires a default constructor</typeparam>
- <param name="db">Index of the DB; es.: 1 is for DB1</param>
- <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- <returns>An instance of the class with the values read from the PLC. If no data has been read, null will be returned</returns>
- </member>
- <member name="M:S7.Net.Plc.ReadClassAsync``1(System.Func{``0},System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Reads all the bytes needed to fill a class in C#, starting from a certain address, and set all the properties values to the value that are read from the PLC.
- This reads only properties, it doesn't read private variable or public variable without {get;set;} specified.
- </summary>
- <typeparam name="T">The class that will be instantiated</typeparam>
- <param name="classFactory">Function to instantiate the class</param>
- <param name="db">Index of the DB; es.: 1 is for DB1</param>
- <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- <returns>An instance of the class with the values read from the PLC. If no data has been read, null will be returned</returns>
- </member>
- <member name="M:S7.Net.Plc.ReadMultipleVarsAsync(System.Collections.Generic.List{S7.Net.Types.DataItem},System.Threading.CancellationToken)">
- <summary>
- Reads multiple vars in a single request.
- You have to create and pass a list of DataItems and you obtain in response the same list with the values.
- Values are stored in the property "Value" of the dataItem and are already converted.
- If you don't want the conversion, just create a dataItem of bytes.
- The number of DataItems as well as the total size of the requested data can not exceed a certain limit (protocol restriction).
- </summary>
- <param name="dataItems">List of dataitems that contains the list of variables that must be read.</param>
- <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- </member>
- <member name="M:S7.Net.Plc.ReadClockAsync(System.Threading.CancellationToken)">
- <summary>
- Read the PLC clock value.
- </summary>
- <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- <returns>A task that represents the asynchronous operation, with it's result set to the current PLC time on completion.</returns>
- </member>
- <member name="M:S7.Net.Plc.WriteClockAsync(System.DateTime,System.Threading.CancellationToken)">
- <summary>
- Write the PLC clock value.
- </summary>
- <param name="value">The date and time to set the PLC clock to</param>
- <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- <returns>A task that represents the asynchronous operation.</returns>
- </member>
- <member name="M:S7.Net.Plc.ReadStatusAsync(System.Threading.CancellationToken)">
- <summary>
- Read the current status from the PLC. A value of 0x08 indicates the PLC is in run status, regardless of the PLC type.
- </summary>
- <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- <returns>A task that represents the asynchronous operation, with it's result set to the current PLC status on completion.</returns>
- </member>
- <member name="M:S7.Net.Plc.WriteBytesAsync(S7.Net.DataType,System.Int32,System.Int32,System.Byte[],System.Threading.CancellationToken)">
- <summary>
- Write a number of bytes from a DB starting from a specified index. This handles more than 200 bytes with multiple requests.
- If the write was not successful, check LastErrorCode or LastErrorString.
- </summary>
- <param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
- <param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
- <param name="startByteAdr">Start byte address. If you want to write DB1.DBW200, this is 200.</param>
- <param name="value">Bytes to write. If more than 200, multiple requests will be made.</param>
- <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- <returns>A task that represents the asynchronous write operation.</returns>
- </member>
- <member name="M:S7.Net.Plc.WriteBytesAsync(S7.Net.DataType,System.Int32,System.Int32,System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)">
- <summary>
- Write a number of bytes from a DB starting from a specified index. This handles more than 200 bytes with multiple requests.
- If the write was not successful, check LastErrorCode or LastErrorString.
- </summary>
- <param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
- <param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
- <param name="startByteAdr">Start byte address. If you want to write DB1.DBW200, this is 200.</param>
- <param name="value">Bytes to write. If more than 200, multiple requests will be made.</param>
- <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- <returns>A task that represents the asynchronous write operation.</returns>
- </member>
- <member name="M:S7.Net.Plc.WriteBitAsync(S7.Net.DataType,System.Int32,System.Int32,System.Int32,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Write a single bit from a DB with the specified index.
- </summary>
- <param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
- <param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
- <param name="startByteAdr">Start byte address. If you want to write DB1.DBW200, this is 200.</param>
- <param name="bitAdr">The address of the bit. (0-7)</param>
- <param name="value">Bytes to write. If more than 200, multiple requests will be made.</param>
- <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- <returns>A task that represents the asynchronous write operation.</returns>
- </member>
- <member name="M:S7.Net.Plc.WriteBitAsync(S7.Net.DataType,System.Int32,System.Int32,System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Write a single bit from a DB with the specified index.
- </summary>
- <param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
- <param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
- <param name="startByteAdr">Start byte address. If you want to write DB1.DBW200, this is 200.</param>
- <param name="bitAdr">The address of the bit. (0-7)</param>
- <param name="value">Bytes to write. If more than 200, multiple requests will be made.</param>
- <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- <returns>A task that represents the asynchronous write operation.</returns>
- </member>
- <member name="M:S7.Net.Plc.WriteAsync(S7.Net.DataType,System.Int32,System.Int32,System.Object,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Takes in input an object and tries to parse it to an array of values. This can be used to write many data, all of the same type.
- You must specify the memory area type, memory are address, byte start address and bytes count.
- If the read was not successful, check LastErrorCode or LastErrorString.
- </summary>
- <param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
- <param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
- <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- <param name="value">Bytes to write. The lenght of this parameter can't be higher than 200. If you need more, use recursion.</param>
- <param name="bitAdr">The address of the bit. (0-7)</param>
- <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- <returns>A task that represents the asynchronous write operation.</returns>
- </member>
- <member name="M:S7.Net.Plc.WriteAsync(System.String,System.Object,System.Threading.CancellationToken)">
- <summary>
- Writes a single variable from the PLC, takes in input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.
- </summary>
- <param name="variable">Input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.</param>
- <param name="value">Value to be written to the PLC</param>
- <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- <returns>A task that represents the asynchronous write operation.</returns>
- </member>
- <member name="M:S7.Net.Plc.WriteStructAsync(System.Object,System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Writes a C# struct to a DB in the PLC
- </summary>
- <param name="structValue">The struct to be written</param>
- <param name="db">Db address</param>
- <param name="startByteAdr">Start bytes on the PLC</param>
- <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- <returns>A task that represents the asynchronous write operation.</returns>
- </member>
- <member name="M:S7.Net.Plc.WriteClassAsync(System.Object,System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Writes a C# class to a DB in the PLC
- </summary>
- <param name="classValue">The class to be written</param>
- <param name="db">Db address</param>
- <param name="startByteAdr">Start bytes on the PLC</param>
- <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- <returns>A task that represents the asynchronous write operation.</returns>
- </member>
- <member name="M:S7.Net.Plc.WriteAsync(S7.Net.Types.DataItem[])">
- <summary>
- Write DataItem(s) to the PLC. Throws an exception if the response is invalid
- or when the PLC reports errors for item(s) written.
- </summary>
- <param name="dataItems">The DataItem(s) to write to the PLC.</param>
- <returns>Task that completes when response from PLC is parsed.</returns>
- </member>
- <member name="M:S7.Net.Plc.WriteBytesWithASingleRequestAsync(S7.Net.DataType,System.Int32,System.Int32,System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)">
- <summary>
- Writes up to 200 bytes to the PLC. You must specify the memory area type, memory are address, byte start address and bytes count.
- </summary>
- <param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
- <param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
- <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- <param name="value">Bytes to write. The lenght of this parameter can't be higher than 200. If you need more, use recursion.</param>
- <param name="cancellationToken">A cancellation token that can be used to cancel the asynchronous operation.</param>
- <returns>A task that represents the asynchronous write operation.</returns>
- </member>
- <member name="M:S7.Net.Plc.WriteReadHeader(System.IO.MemoryStream,System.Int32)">
- <summary>
- Creates the header to read bytes from the PLC.
- </summary>
- <param name="stream">The stream to write to.</param>
- <param name="amount">The number of items to read.</param>
- </member>
- <member name="M:S7.Net.Plc.BuildReadDataRequestPackage(System.IO.MemoryStream,S7.Net.DataType,System.Int32,System.Int32,System.Int32)">
- <summary>
- Create the bytes-package to request data from the PLC. You have to specify the memory type (dataType),
- the address of the memory, the address of the byte and the bytes count.
- </summary>
- <param name="stream">The stream to write the read data request to.</param>
- <param name="dataType">MemoryType (DB, Timer, Counter, etc.)</param>
- <param name="db">Address of the memory to be read</param>
- <param name="startByteAdr">Start address of the byte</param>
- <param name="count">Number of bytes to be read</param>
- <returns></returns>
- </member>
- <member name="M:S7.Net.Plc.ParseBytes(S7.Net.VarType,System.Byte[],System.Int32,System.Byte)">
- <summary>
- Given a S7 variable type (Bool, Word, DWord, etc.), it converts the bytes in the appropriate C# format.
- </summary>
- <param name="varType"></param>
- <param name="bytes"></param>
- <param name="varCount"></param>
- <param name="bitAdr"></param>
- <returns></returns>
- </member>
- <member name="M:S7.Net.Plc.VarTypeToByteLength(S7.Net.VarType,System.Int32)">
- <summary>
- Given a S7 <see cref="T:S7.Net.VarType"/> (Bool, Word, DWord, etc.), it returns how many bytes to read.
- </summary>
- <param name="varType"></param>
- <param name="varCount"></param>
- <returns>Byte lenght of variable</returns>
- </member>
- <member name="M:S7.Net.Plc.Open">
- <summary>
- Connects to the PLC and performs a COTP ConnectionRequest and S7 CommunicationSetup.
- </summary>
- </member>
- <member name="M:S7.Net.Plc.ReadBytes(S7.Net.DataType,System.Int32,System.Int32,System.Int32)">
- <summary>
- Reads a number of bytes from a DB starting from a specified index. This handles more than 200 bytes with multiple requests.
- If the read was not successful, check LastErrorCode or LastErrorString.
- </summary>
- <param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
- <param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
- <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- <param name="count">Byte count, if you want to read 120 bytes, set this to 120.</param>
- <returns>Returns the bytes in an array</returns>
- </member>
- <member name="M:S7.Net.Plc.ReadBytes(System.Span{System.Byte},S7.Net.DataType,System.Int32,System.Int32)">
- <summary>
- Reads a number of bytes from a DB starting from a specified index. This handles more than 200 bytes with multiple requests.
- If the read was not successful, check LastErrorCode or LastErrorString.
- </summary>
- <param name="buffer">Buffer to receive the read bytes. The <see cref="P:System.Span`1.Length"/> determines the number of bytes to read.</param>
- <param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
- <param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
- <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- <returns>Returns the bytes in an array</returns>
- </member>
- <member name="M:S7.Net.Plc.Read(S7.Net.DataType,System.Int32,System.Int32,S7.Net.VarType,System.Int32,System.Byte)">
- <summary>
- Read and decode a certain number of bytes of the "VarType" provided.
- This can be used to read multiple consecutive variables of the same type (Word, DWord, Int, etc).
- If the read was not successful, check LastErrorCode or LastErrorString.
- </summary>
- <param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
- <param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
- <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- <param name="varType">Type of the variable/s that you are reading</param>
- <param name="bitAdr">Address of bit. If you want to read DB1.DBX200.6, set 6 to this parameter.</param>
- <param name="varCount"></param>
- </member>
- <member name="M:S7.Net.Plc.Read(System.String)">
- <summary>
- Reads a single variable from the PLC, takes in input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.
- If the read was not successful, check LastErrorCode or LastErrorString.
- </summary>
- <param name="variable">Input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.</param>
- <returns>Returns an object that contains the value. This object must be cast accordingly. If no data has been read, null will be returned</returns>
- </member>
- <member name="M:S7.Net.Plc.ReadStruct(System.Type,System.Int32,System.Int32)">
- <summary>
- Reads all the bytes needed to fill a struct in C#, starting from a certain address, and return an object that can be casted to the struct.
- </summary>
- <param name="structType">Type of the struct to be readed (es.: TypeOf(MyStruct)).</param>
- <param name="db">Address of the DB.</param>
- <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- <returns>Returns a struct that must be cast. If no data has been read, null will be returned</returns>
- </member>
- <member name="M:S7.Net.Plc.ReadStruct``1(System.Int32,System.Int32)">
- <summary>
- Reads all the bytes needed to fill a struct in C#, starting from a certain address, and returns the struct or null if nothing was read.
- </summary>
- <typeparam name="T">The struct type</typeparam>
- <param name="db">Address of the DB.</param>
- <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- <returns>Returns a nullable struct. If nothing was read null will be returned.</returns>
- </member>
- <member name="M:S7.Net.Plc.ReadClass(System.Object,System.Int32,System.Int32)">
- <summary>
- Reads all the bytes needed to fill a class in C#, starting from a certain address, and set all the properties values to the value that are read from the PLC.
- This reads only properties, it doesn't read private variable or public variable without {get;set;} specified.
- </summary>
- <param name="sourceClass">Instance of the class that will store the values</param>
- <param name="db">Index of the DB; es.: 1 is for DB1</param>
- <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- <returns>The number of read bytes</returns>
- </member>
- <member name="M:S7.Net.Plc.ReadClass``1(System.Int32,System.Int32)">
- <summary>
- Reads all the bytes needed to fill a class in C#, starting from a certain address, and set all the properties values to the value that are read from the PLC.
- This reads only properties, it doesn't read private variable or public variable without {get;set;} specified. To instantiate the class defined by the generic
- type, the class needs a default constructor.
- </summary>
- <typeparam name="T">The class that will be instantiated. Requires a default constructor</typeparam>
- <param name="db">Index of the DB; es.: 1 is for DB1</param>
- <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- <returns>An instance of the class with the values read from the PLC. If no data has been read, null will be returned</returns>
- </member>
- <member name="M:S7.Net.Plc.ReadClass``1(System.Func{``0},System.Int32,System.Int32)">
- <summary>
- Reads all the bytes needed to fill a class in C#, starting from a certain address, and set all the properties values to the value that are read from the PLC.
- This reads only properties, it doesn't read private variable or public variable without {get;set;} specified.
- </summary>
- <typeparam name="T">The class that will be instantiated</typeparam>
- <param name="classFactory">Function to instantiate the class</param>
- <param name="db">Index of the DB; es.: 1 is for DB1</param>
- <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- <returns>An instance of the class with the values read from the PLC. If no data has been read, null will be returned</returns>
- </member>
- <member name="M:S7.Net.Plc.WriteBytes(S7.Net.DataType,System.Int32,System.Int32,System.Byte[])">
- <summary>
- Write a number of bytes from a DB starting from a specified index. This handles more than 200 bytes with multiple requests.
- If the write was not successful, check LastErrorCode or LastErrorString.
- </summary>
- <param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
- <param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
- <param name="startByteAdr">Start byte address. If you want to write DB1.DBW200, this is 200.</param>
- <param name="value">Bytes to write. If more than 200, multiple requests will be made.</param>
- </member>
- <member name="M:S7.Net.Plc.WriteBytes(S7.Net.DataType,System.Int32,System.Int32,System.ReadOnlySpan{System.Byte})">
- <summary>
- Write a number of bytes from a DB starting from a specified index. This handles more than 200 bytes with multiple requests.
- If the write was not successful, check LastErrorCode or LastErrorString.
- </summary>
- <param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
- <param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
- <param name="startByteAdr">Start byte address. If you want to write DB1.DBW200, this is 200.</param>
- <param name="value">Bytes to write. If more than 200, multiple requests will be made.</param>
- </member>
- <member name="M:S7.Net.Plc.WriteBit(S7.Net.DataType,System.Int32,System.Int32,System.Int32,System.Boolean)">
- <summary>
- Write a single bit from a DB with the specified index.
- </summary>
- <param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
- <param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
- <param name="startByteAdr">Start byte address. If you want to write DB1.DBW200, this is 200.</param>
- <param name="bitAdr">The address of the bit. (0-7)</param>
- <param name="value">Bytes to write. If more than 200, multiple requests will be made.</param>
- </member>
- <member name="M:S7.Net.Plc.WriteBit(S7.Net.DataType,System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Write a single bit to a DB with the specified index.
- </summary>
- <param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
- <param name="db">Address of the memory area (if you want to write DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
- <param name="startByteAdr">Start byte address. If you want to write DB1.DBW200, this is 200.</param>
- <param name="bitAdr">The address of the bit. (0-7)</param>
- <param name="value">Value to write (0 or 1).</param>
- </member>
- <member name="M:S7.Net.Plc.Write(S7.Net.DataType,System.Int32,System.Int32,System.Object,System.Int32)">
- <summary>
- Takes in input an object and tries to parse it to an array of values. This can be used to write many data, all of the same type.
- You must specify the memory area type, memory are address, byte start address and bytes count.
- If the read was not successful, check LastErrorCode or LastErrorString.
- </summary>
- <param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
- <param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
- <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- <param name="value">Bytes to write. The lenght of this parameter can't be higher than 200. If you need more, use recursion.</param>
- <param name="bitAdr">The address of the bit. (0-7)</param>
- </member>
- <member name="M:S7.Net.Plc.Write(System.String,System.Object)">
- <summary>
- Writes a single variable from the PLC, takes in input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.
- </summary>
- <param name="variable">Input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.</param>
- <param name="value">Value to be written to the PLC</param>
- </member>
- <member name="M:S7.Net.Plc.WriteStruct(System.Object,System.Int32,System.Int32)">
- <summary>
- Writes a C# struct to a DB in the PLC
- </summary>
- <param name="structValue">The struct to be written</param>
- <param name="db">Db address</param>
- <param name="startByteAdr">Start bytes on the PLC</param>
- </member>
- <member name="M:S7.Net.Plc.WriteClass(System.Object,System.Int32,System.Int32)">
- <summary>
- Writes a C# class to a DB in the PLC
- </summary>
- <param name="classValue">The class to be written</param>
- <param name="db">Db address</param>
- <param name="startByteAdr">Start bytes on the PLC</param>
- </member>
- <member name="M:S7.Net.Plc.Write(S7.Net.Types.DataItem[])">
- <summary>
- Write DataItem(s) to the PLC. Throws an exception if the response is invalid
- or when the PLC reports errors for item(s) written.
- </summary>
- <param name="dataItems">The DataItem(s) to write to the PLC.</param>
- </member>
- <member name="M:S7.Net.Plc.ReadMultipleVars(System.Collections.Generic.List{S7.Net.Types.DataItem})">
- <summary>
- Reads multiple vars in a single request.
- You have to create and pass a list of DataItems and you obtain in response the same list with the values.
- Values are stored in the property "Value" of the dataItem and are already converted.
- If you don't want the conversion, just create a dataItem of bytes.
- The number of DataItems as well as the total size of the requested data can not exceed a certain limit (protocol restriction).
- </summary>
- <param name="dataItems">List of dataitems that contains the list of variables that must be read.</param>
- </member>
- <member name="M:S7.Net.Plc.ReadClock">
- <summary>
- Read the PLC clock value.
- </summary>
- <returns>The current PLC time.</returns>
- </member>
- <member name="M:S7.Net.Plc.WriteClock(System.DateTime)">
- <summary>
- Write the PLC clock value.
- </summary>
- <param name="value">The date and time to set the PLC clock to.</param>
- </member>
- <member name="M:S7.Net.Plc.ReadStatus">
- <summary>
- Read the current status from the PLC. A value of 0x08 indicates the PLC is in run status, regardless of the PLC type.
- </summary>
- <returns>The current PLC status.</returns>
- </member>
- <member name="T:S7.Net.Protocol.S7.DataItemAddress">
- <summary>
- Represents an area of memory in the PLC
- </summary>
- </member>
- <member name="P:S7.Net.Protocol.S7.DataItemAddress.DataType">
- <summary>
- Memory area to read
- </summary>
- </member>
- <member name="P:S7.Net.Protocol.S7.DataItemAddress.DB">
- <summary>
- Address of memory area to read (example: for DB1 this value is 1, for T45 this value is 45)
- </summary>
- </member>
- <member name="P:S7.Net.Protocol.S7.DataItemAddress.StartByteAddress">
- <summary>
- Address of the first byte to read
- </summary>
- </member>
- <member name="P:S7.Net.Protocol.S7.DataItemAddress.ByteLength">
- <summary>
- Length of data to read
- </summary>
- </member>
- <member name="T:S7.Net.Protocol.Tsap">
- <summary>
- Provides a representation of the Transport Service Access Point, or TSAP in short. TSAP's are used
- to specify a client and server address. For most PLC types a default TSAP is available that allows
- connection from any IP and can be calculated using the rack and slot numbers.
- </summary>
- </member>
- <member name="P:S7.Net.Protocol.Tsap.FirstByte">
- <summary>
- First byte of the TSAP.
- </summary>
- </member>
- <member name="P:S7.Net.Protocol.Tsap.SecondByte">
- <summary>
- Second byte of the TSAP.
- </summary>
- </member>
- <member name="M:S7.Net.Protocol.Tsap.#ctor(System.Byte,System.Byte)">
- <summary>
- Initializes a new instance of the <see cref="T:S7.Net.Protocol.Tsap" /> class using the specified values.
- </summary>
- <param name="firstByte">The first byte of the TSAP.</param>
- <param name="secondByte">The second byte of the TSAP.</param>
- </member>
- <member name="T:S7.Net.Protocol.TsapPair">
- <summary>
- Implements a pair of TSAP addresses used to connect to a PLC.
- </summary>
- </member>
- <member name="P:S7.Net.Protocol.TsapPair.Local">
- <summary>
- The local <see cref="T:S7.Net.Protocol.Tsap" />.
- </summary>
- </member>
- <member name="P:S7.Net.Protocol.TsapPair.Remote">
- <summary>
- The remote <see cref="T:S7.Net.Protocol.Tsap" />
- </summary>
- </member>
- <member name="M:S7.Net.Protocol.TsapPair.#ctor(S7.Net.Protocol.Tsap,S7.Net.Protocol.Tsap)">
- <summary>
- Initializes a new instance of the <see cref="T:S7.Net.Protocol.TsapPair" /> class using the specified local and
- remote TSAP.
- </summary>
- <param name="local">The local TSAP.</param>
- <param name="remote">The remote TSAP.</param>
- </member>
- <member name="M:S7.Net.Protocol.TsapPair.GetDefaultTsapPair(S7.Net.CpuType,System.Int32,System.Int32)">
- <summary>
- Builds a <see cref="T:S7.Net.Protocol.TsapPair" /> that can be used to connect to a PLC using the default connection
- addresses.
- </summary>
- <remarks>
- The remote TSAP is constructed using <code>new Tsap(0x03, (byte) ((rack << 5) | slot))</code>.
- </remarks>
- <param name="cpuType">The CPU type of the PLC.</param>
- <param name="rack">The rack of the PLC's network card.</param>
- <param name="slot">The slot of the PLC's network card.</param>
- <returns>A TSAP pair that matches the given parameters.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="cpuType"/> is invalid.
-
- -or-
-
- The <paramref name="rack"/> parameter is less than 0.
-
- -or-
-
- The <paramref name="rack"/> parameter is greater than 15.
-
- -or-
-
- The <paramref name="slot"/> parameter is less than 0.
-
- -or-
-
- The <paramref name="slot"/> parameter is greater than 15.</exception>
- </member>
- <member name="T:S7.Net.StreamExtensions">
- <summary>
- Extensions for Streams
- </summary>
- </member>
- <member name="M:S7.Net.StreamExtensions.ReadExact(System.IO.Stream,System.Byte[],System.Int32,System.Int32)">
- <summary>
- Reads bytes from the stream into the buffer until exactly the requested number of bytes (or EOF) have been read
- </summary>
- <param name="stream">the Stream to read from</param>
- <param name="buffer">the buffer to read into</param>
- <param name="offset">the offset in the buffer to read into</param>
- <param name="count">the amount of bytes to read into the buffer</param>
- <returns>returns the amount of read bytes</returns>
- </member>
- <member name="M:S7.Net.StreamExtensions.ReadExactAsync(System.IO.Stream,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Reads bytes from the stream into the buffer until exactly the requested number of bytes (or EOF) have been read
- </summary>
- <param name="stream">the Stream to read from</param>
- <param name="buffer">the buffer to read into</param>
- <param name="offset">the offset in the buffer to read into</param>
- <param name="count">the amount of bytes to read into the buffer</param>
- <param name="cancellationToken">A cancellation token that can be used to cancel the asynchronous operation.</param>
- <returns>returns the amount of read bytes</returns>
- </member>
- <member name="T:S7.Net.TPKT">
- <summary>
- Describes a TPKT Packet
- </summary>
- </member>
- <member name="M:S7.Net.TPKT.ReadAsync(System.IO.Stream,System.Threading.CancellationToken)">
- <summary>
- Reads a TPKT from the socket Async
- </summary>
- <param name="stream">The stream to read from</param>
- <param name="cancellationToken">A cancellation token that can be used to cancel the asynchronous operation.</param>
- <returns>Task TPKT Instace</returns>
- </member>
- <member name="T:S7.Net.Types.Bit">
- <summary>
- Contains the conversion methods to convert Bit from S7 plc to C#.
- </summary>
- </member>
- <member name="M:S7.Net.Types.Bit.FromByte(System.Byte,System.Byte)">
- <summary>
- Converts a Bit to bool
- </summary>
- </member>
- <member name="M:S7.Net.Types.Bit.ToBitArray(System.Byte[])">
- <summary>
- Converts an array of bytes to a BitArray.
- </summary>
- <param name="bytes">The bytes to convert.</param>
- <returns>A BitArray with the same number of bits and equal values as <paramref name="bytes"/>.</returns>
- </member>
- <member name="M:S7.Net.Types.Bit.ToBitArray(System.Byte[],System.Int32)">
- <summary>
- Converts an array of bytes to a BitArray.
- </summary>
- <param name="bytes">The bytes to convert.</param>
- <param name="length">The number of bits to return.</param>
- <returns>A BitArray with <paramref name="length"/> bits.</returns>
- </member>
- <member name="T:S7.Net.Types.Boolean">
- <summary>
- Contains the methods to read, set and reset bits inside bytes
- </summary>
- </member>
- <member name="M:S7.Net.Types.Boolean.GetValue(System.Byte,System.Int32)">
- <summary>
- Returns the value of a bit in a bit, given the address of the bit
- </summary>
- </member>
- <member name="M:S7.Net.Types.Boolean.SetBit(System.Byte,System.Int32)">
- <summary>
- Sets the value of a bit to 1 (true), given the address of the bit. Returns
- a copy of the value with the bit set.
- </summary>
- <param name="value">The input value to modify.</param>
- <param name="bit">The index (zero based) of the bit to set.</param>
- <returns>The modified value with the bit at index set.</returns>
- </member>
- <member name="M:S7.Net.Types.Boolean.SetBit(System.Byte@,System.Int32)">
- <summary>
- Sets the value of a bit to 1 (true), given the address of the bit.
- </summary>
- <param name="value">The value to modify.</param>
- <param name="bit">The index (zero based) of the bit to set.</param>
- </member>
- <member name="M:S7.Net.Types.Boolean.ClearBit(System.Byte,System.Int32)">
- <summary>
- Resets the value of a bit to 0 (false), given the address of the bit. Returns
- a copy of the value with the bit cleared.
- </summary>
- <param name="value">The input value to modify.</param>
- <param name="bit">The index (zero based) of the bit to clear.</param>
- <returns>The modified value with the bit at index cleared.</returns>
- </member>
- <member name="M:S7.Net.Types.Boolean.ClearBit(System.Byte@,System.Int32)">
- <summary>
- Resets the value of a bit to 0 (false), given the address of the bit
- </summary>
- <param name="value">The input value to modify.</param>
- <param name="bit">The index (zero based) of the bit to clear.</param>
- </member>
- <member name="T:S7.Net.Types.Byte">
- <summary>
- Contains the methods to convert from bytes to byte arrays
- </summary>
- </member>
- <member name="M:S7.Net.Types.Byte.ToByteArray(System.Byte)">
- <summary>
- Converts a byte to byte array
- </summary>
- </member>
- <member name="M:S7.Net.Types.Byte.FromByteArray(System.Byte[])">
- <summary>
- Converts a byte array to byte
- </summary>
- <param name="bytes"></param>
- <returns></returns>
- </member>
- <member name="T:S7.Net.Types.Class">
- <summary>
- Contains the methods to convert a C# class to S7 data types
- </summary>
- </member>
- <member name="M:S7.Net.Types.Class.GetClassSize(System.Object,System.Double,System.Boolean)">
- <summary>
- Gets the size of the class in bytes.
- </summary>
- <param name="instance">An instance of the class</param>
- <param name="numBytes">The offset of the current field.</param>
- <param name="isInnerProperty"><see langword="true" /> if this property belongs to a class being serialized as member of the class requested for serialization; otherwise, <see langword="false" />.</param>
- <returns>the number of bytes</returns>
- </member>
- <member name="M:S7.Net.Types.Class.FromBytes(System.Object,System.Byte[],System.Double,System.Boolean)">
- <summary>
- Sets the object's values with the given array of bytes
- </summary>
- <param name="sourceClass">The object to fill in the given array of bytes</param>
- <param name="bytes">The array of bytes</param>
- <param name="numBytes">The offset for the current field.</param>
- <param name="isInnerClass"><see langword="true" /> if this class is the type of a member of the class to be serialized; otherwise, <see langword="false" />.</param>
- </member>
- <member name="M:S7.Net.Types.Class.ToBytes(System.Object,System.Byte[],System.Double)">
- <summary>
- Creates a byte array depending on the struct type.
- </summary>
- <param name="sourceClass">The struct object.</param>
- <param name="bytes">The target byte array.</param>
- <param name="numBytes">The offset for the current field.</param>
- <returns>A byte array or null if fails.</returns>
- </member>
- <member name="T:S7.Net.Types.Counter">
- <summary>
- Contains the conversion methods to convert Counter from S7 plc to C# ushort (UInt16).
- </summary>
- </member>
- <member name="M:S7.Net.Types.Counter.FromByteArray(System.Byte[])">
- <summary>
- Converts a Counter (2 bytes) to ushort (UInt16)
- </summary>
- </member>
- <member name="M:S7.Net.Types.Counter.ToByteArray(System.UInt16)">
- <summary>
- Converts a ushort (UInt16) to word (2 bytes)
- </summary>
- </member>
- <member name="M:S7.Net.Types.Counter.ToByteArray(System.UInt16[])">
- <summary>
- Converts an array of ushort (UInt16) to an array of bytes
- </summary>
- </member>
- <member name="M:S7.Net.Types.Counter.ToArray(System.Byte[])">
- <summary>
- Converts an array of bytes to an array of ushort
- </summary>
- </member>
- <member name="T:S7.Net.Types.DataItem">
- <summary>
- Create an instance of a memory block that can be read by using ReadMultipleVars
- </summary>
- </member>
- <member name="P:S7.Net.Types.DataItem.DataType">
- <summary>
- Memory area to read
- </summary>
- </member>
- <member name="P:S7.Net.Types.DataItem.VarType">
- <summary>
- Type of data to be read (default is bytes)
- </summary>
- </member>
- <member name="P:S7.Net.Types.DataItem.DB">
- <summary>
- Address of memory area to read (example: for DB1 this value is 1, for T45 this value is 45)
- </summary>
- </member>
- <member name="P:S7.Net.Types.DataItem.StartByteAdr">
- <summary>
- Address of the first byte to read
- </summary>
- </member>
- <member name="P:S7.Net.Types.DataItem.BitAdr">
- <summary>
- Addess of bit to read from StartByteAdr
- </summary>
- </member>
- <member name="P:S7.Net.Types.DataItem.Count">
- <summary>
- Number of variables to read
- </summary>
- </member>
- <member name="P:S7.Net.Types.DataItem.Value">
- <summary>
- Contains the value of the memory area after the read has been executed
- </summary>
- </member>
- <member name="M:S7.Net.Types.DataItem.#ctor">
- <summary>
- Create an instance of DataItem
- </summary>
- </member>
- <member name="M:S7.Net.Types.DataItem.FromAddress(System.String)">
- <summary>
- Create an instance of <see cref="T:S7.Net.Types.DataItem"/> from the supplied address.
- </summary>
- <param name="address">The address to create the DataItem for.</param>
- <returns>A new <see cref="T:S7.Net.Types.DataItem"/> instance with properties parsed from <paramref name="address"/>.</returns>
- <remarks>The <see cref="P:S7.Net.Types.DataItem.Count" /> property is not parsed from the address.</remarks>
- </member>
- <member name="M:S7.Net.Types.DataItem.FromAddressAndValue``1(System.String,``0)">
- <summary>
- Create an instance of <see cref="T:S7.Net.Types.DataItem"/> from the supplied address and value.
- </summary>
- <param name="address">The address to create the DataItem for.</param>
- <param name="value">The value to be applied to the DataItem.</param>
- <returns>A new <see cref="T:S7.Net.Types.DataItem"/> instance with properties parsed from <paramref name="address"/> and the supplied value set.</returns>
- </member>
- <member name="T:S7.Net.Types.Date">
- <summary>
- Contains the conversion methods to convert Words from S7 plc to C#.
- </summary>
- </member>
- <member name="P:S7.Net.Types.Date.IecMinDate">
- <summary>
- Minimum allowed date for the IEC date type
- </summary>
- </member>
- <member name="P:S7.Net.Types.Date.IecMaxDate">
- <summary>
- Maximum allowed date for the IEC date type
- <remarks>
- Although the spec allows only a max date of 31-12-2168, the PLC IEC date goes up to 06-06-2169 (which is the actual
- WORD max value - 65535)
- </remarks>
- </summary>
- </member>
- <member name="M:S7.Net.Types.Date.FromByteArray(System.Byte[])">
- <summary>
- Converts a word (2 bytes) to IEC date (<see cref="T:System.DateTime"/>)
- </summary>
- </member>
- <member name="M:S7.Net.Types.Date.ToByteArray(System.DateTime)">
- <summary>
- Converts a <see cref="T:System.DateTime"/> to word (2 bytes)
- </summary>
- </member>
- <member name="M:S7.Net.Types.Date.ToByteArray(System.DateTime[])">
- <summary>
- Converts an array of <see cref="T:System.DateTime"/>s to an array of bytes
- </summary>
- </member>
- <member name="M:S7.Net.Types.Date.ToArray(System.Byte[])">
- <summary>
- Converts an array of bytes to an array of <see cref="T:System.DateTime"/>s
- </summary>
- </member>
- <member name="T:S7.Net.Types.DateTime">
- <summary>
- Contains the methods to convert between <see cref="T:System.DateTime"/> and S7 representation of datetime values.
- </summary>
- </member>
- <member name="F:S7.Net.Types.DateTime.SpecMinimumDateTime">
- <summary>
- The minimum <see cref="T:System.DateTime"/> value supported by the specification.
- </summary>
- </member>
- <member name="F:S7.Net.Types.DateTime.SpecMaximumDateTime">
- <summary>
- The maximum <see cref="T:System.DateTime"/> value supported by the specification.
- </summary>
- </member>
- <member name="M:S7.Net.Types.DateTime.FromByteArray(System.Byte[])">
- <summary>
- Parses a <see cref="T:System.DateTime"/> value from bytes.
- </summary>
- <param name="bytes">Input bytes read from PLC.</param>
- <returns>A <see cref="T:System.DateTime"/> object representing the value read from PLC.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the length of
- <paramref name="bytes"/> is not 8 or any value in <paramref name="bytes"/>
- is outside the valid range of values.</exception>
- </member>
- <member name="M:S7.Net.Types.DateTime.ToArray(System.Byte[])">
- <summary>
- Parses an array of <see cref="T:System.DateTime"/> values from bytes.
- </summary>
- <param name="bytes">Input bytes read from PLC.</param>
- <returns>An array of <see cref="T:System.DateTime"/> objects representing the values read from PLC.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the length of
- <paramref name="bytes"/> is not a multiple of 8 or any value in
- <paramref name="bytes"/> is outside the valid range of values.</exception>
- </member>
- <member name="M:S7.Net.Types.DateTime.ToByteArray(System.DateTime)">
- <summary>
- Converts a <see cref="T:System.DateTime"/> value to a byte array.
- </summary>
- <param name="dateTime">The DateTime value to convert.</param>
- <returns>A byte array containing the S7 date time representation of <paramref name="dateTime"/>.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the value of
- <paramref name="dateTime"/> is before <see cref="P:SpecMinimumDateTime"/>
- or after <see cref="P:SpecMaximumDateTime"/>.</exception>
- </member>
- <member name="M:S7.Net.Types.DateTime.ToByteArray(System.DateTime[])">
- <summary>
- Converts an array of <see cref="T:System.DateTime"/> values to a byte array.
- </summary>
- <param name="dateTimes">The DateTime values to convert.</param>
- <returns>A byte array containing the S7 date time representations of <paramref name="dateTimes"/>.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when any value of
- <paramref name="dateTimes"/> is before <see cref="P:SpecMinimumDateTime"/>
- or after <see cref="P:SpecMaximumDateTime"/>.</exception>
- </member>
- <member name="T:S7.Net.Types.DateTimeLong">
- <summary>
- Contains the methods to convert between <see cref="T:System.DateTime" /> and S7 representation of DateTimeLong (DTL) values.
- </summary>
- </member>
- <member name="F:S7.Net.Types.DateTimeLong.SpecMinimumDateTime">
- <summary>
- The minimum <see cref="T:System.DateTime" /> value supported by the specification.
- </summary>
- </member>
- <member name="F:S7.Net.Types.DateTimeLong.SpecMaximumDateTime">
- <summary>
- The maximum <see cref="T:System.DateTime" /> value supported by the specification.
- </summary>
- </member>
- <member name="M:S7.Net.Types.DateTimeLong.FromByteArray(System.Byte[])">
- <summary>
- Parses a <see cref="T:System.DateTime" /> value from bytes.
- </summary>
- <param name="bytes">Input bytes read from PLC.</param>
- <returns>A <see cref="T:System.DateTime" /> object representing the value read from PLC.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">
- Thrown when the length of
- <paramref name="bytes" /> is not 12 or any value in <paramref name="bytes" />
- is outside the valid range of values.
- </exception>
- </member>
- <member name="M:S7.Net.Types.DateTimeLong.ToArray(System.Byte[])">
- <summary>
- Parses an array of <see cref="T:System.DateTime" /> values from bytes.
- </summary>
- <param name="bytes">Input bytes read from PLC.</param>
- <returns>An array of <see cref="T:System.DateTime" /> objects representing the values read from PLC.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">
- Thrown when the length of
- <paramref name="bytes" /> is not a multiple of 12 or any value in
- <paramref name="bytes" /> is outside the valid range of values.
- </exception>
- </member>
- <member name="M:S7.Net.Types.DateTimeLong.ToByteArray(System.DateTime)">
- <summary>
- Converts a <see cref="T:System.DateTime" /> value to a byte array.
- </summary>
- <param name="dateTime">The DateTime value to convert.</param>
- <returns>A byte array containing the S7 DateTimeLong representation of <paramref name="dateTime" />.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">
- Thrown when the value of
- <paramref name="dateTime" /> is before <see cref="P:SpecMinimumDateTime" />
- or after <see cref="P:SpecMaximumDateTime" />.
- </exception>
- </member>
- <member name="M:S7.Net.Types.DateTimeLong.ToByteArray(System.DateTime[])">
- <summary>
- Converts an array of <see cref="T:System.DateTime" /> values to a byte array.
- </summary>
- <param name="dateTimes">The DateTime values to convert.</param>
- <returns>A byte array containing the S7 DateTimeLong representations of <paramref name="dateTimes" />.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">
- Thrown when any value of
- <paramref name="dateTimes" /> is before <see cref="P:SpecMinimumDateTime" />
- or after <see cref="P:SpecMaximumDateTime" />.
- </exception>
- </member>
- <member name="T:S7.Net.Types.DInt">
- <summary>
- Contains the conversion methods to convert DInt from S7 plc to C# int (Int32).
- </summary>
- </member>
- <member name="M:S7.Net.Types.DInt.FromByteArray(System.Byte[])">
- <summary>
- Converts a S7 DInt (4 bytes) to int (Int32)
- </summary>
- </member>
- <member name="M:S7.Net.Types.DInt.ToByteArray(System.Int32)">
- <summary>
- Converts a int (Int32) to S7 DInt (4 bytes)
- </summary>
- </member>
- <member name="M:S7.Net.Types.DInt.ToByteArray(System.Int32[])">
- <summary>
- Converts an array of int (Int32) to an array of bytes
- </summary>
- </member>
- <member name="M:S7.Net.Types.DInt.ToArray(System.Byte[])">
- <summary>
- Converts an array of S7 DInt to an array of int (Int32)
- </summary>
- </member>
- <member name="T:S7.Net.Types.Double">
- <summary>
- Contains the conversion methods to convert Real from S7 plc to C# double.
- </summary>
- </member>
- <member name="M:S7.Net.Types.Double.FromByteArray(System.Byte[])">
- <summary>
- Converts a S7 Real (4 bytes) to double
- </summary>
- </member>
- <member name="M:S7.Net.Types.Double.FromDWord(System.Int32)">
- <summary>
- Converts a S7 DInt to double
- </summary>
- </member>
- <member name="M:S7.Net.Types.Double.FromDWord(System.UInt32)">
- <summary>
- Converts a S7 DWord to double
- </summary>
- </member>
- <member name="M:S7.Net.Types.Double.ToByteArray(System.Double)">
- <summary>
- Converts a double to S7 Real (4 bytes)
- </summary>
- </member>
- <member name="M:S7.Net.Types.Double.ToByteArray(System.Double[])">
- <summary>
- Converts an array of double to an array of bytes
- </summary>
- </member>
- <member name="M:S7.Net.Types.Double.ToArray(System.Byte[])">
- <summary>
- Converts an array of S7 Real to an array of double
- </summary>
- </member>
- <member name="T:S7.Net.Types.DWord">
- <summary>
- Contains the conversion methods to convert DWord from S7 plc to C#.
- </summary>
- </member>
- <member name="M:S7.Net.Types.DWord.FromByteArray(System.Byte[])">
- <summary>
- Converts a S7 DWord (4 bytes) to uint (UInt32)
- </summary>
- </member>
- <member name="M:S7.Net.Types.DWord.FromBytes(System.Byte,System.Byte,System.Byte,System.Byte)">
- <summary>
- Converts 4 bytes to DWord (UInt32)
- </summary>
- </member>
- <member name="M:S7.Net.Types.DWord.ToByteArray(System.UInt32)">
- <summary>
- Converts a uint (UInt32) to S7 DWord (4 bytes)
- </summary>
- </member>
- <member name="M:S7.Net.Types.DWord.ToByteArray(System.UInt32[])">
- <summary>
- Converts an array of uint (UInt32) to an array of S7 DWord (4 bytes)
- </summary>
- </member>
- <member name="M:S7.Net.Types.DWord.ToArray(System.Byte[])">
- <summary>
- Converts an array of S7 DWord to an array of uint (UInt32)
- </summary>
- </member>
- <member name="T:S7.Net.Types.Int">
- <summary>
- Contains the conversion methods to convert Int from S7 plc to C#.
- </summary>
- </member>
- <member name="M:S7.Net.Types.Int.FromByteArray(System.Byte[])">
- <summary>
- Converts a S7 Int (2 bytes) to short (Int16)
- </summary>
- </member>
- <member name="M:S7.Net.Types.Int.ToByteArray(System.Int16)">
- <summary>
- Converts a short (Int16) to a S7 Int byte array (2 bytes)
- </summary>
- </member>
- <member name="M:S7.Net.Types.Int.ToByteArray(System.Int16[])">
- <summary>
- Converts an array of short (Int16) to a S7 Int byte array (2 bytes)
- </summary>
- </member>
- <member name="M:S7.Net.Types.Int.ToArray(System.Byte[])">
- <summary>
- Converts an array of S7 Int to an array of short (Int16)
- </summary>
- </member>
- <member name="M:S7.Net.Types.Int.CWord(System.Int32)">
- <summary>
- Converts a C# int value to a C# short value, to be used as word.
- </summary>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="T:S7.Net.Types.LReal">
- <summary>
- Contains the conversion methods to convert Real from S7 plc to C# double.
- </summary>
- </member>
- <member name="M:S7.Net.Types.LReal.FromByteArray(System.Byte[])">
- <summary>
- Converts a S7 LReal (8 bytes) to double
- </summary>
- </member>
- <member name="M:S7.Net.Types.LReal.ToByteArray(System.Double)">
- <summary>
- Converts a double to S7 LReal (8 bytes)
- </summary>
- </member>
- <member name="M:S7.Net.Types.LReal.ToByteArray(System.Double[])">
- <summary>
- Converts an array of double to an array of bytes
- </summary>
- </member>
- <member name="M:S7.Net.Types.LReal.ToArray(System.Byte[])">
- <summary>
- Converts an array of S7 LReal to an array of double
- </summary>
- </member>
- <member name="T:S7.Net.Types.Real">
- <summary>
- Contains the conversion methods to convert Real from S7 plc to C# double.
- </summary>
- </member>
- <member name="M:S7.Net.Types.Real.FromByteArray(System.Byte[])">
- <summary>
- Converts a S7 Real (4 bytes) to float
- </summary>
- </member>
- <member name="M:S7.Net.Types.Real.ToByteArray(System.Single)">
- <summary>
- Converts a float to S7 Real (4 bytes)
- </summary>
- </member>
- <member name="M:S7.Net.Types.Real.ToByteArray(System.Single[])">
- <summary>
- Converts an array of float to an array of bytes
- </summary>
- </member>
- <member name="M:S7.Net.Types.Real.ToArray(System.Byte[])">
- <summary>
- Converts an array of S7 Real to an array of float
- </summary>
- </member>
- <member name="T:S7.Net.Types.S7String">
- <summary>
- Contains the methods to convert from S7 strings to C# strings
- An S7 String has a preceeding 2 byte header containing its capacity and length
- </summary>
- </member>
- <member name="P:S7.Net.Types.S7String.StringEncoding">
- <summary>
- The Encoding used when serializing and deserializing S7String (Encoding.ASCII by default)
- </summary>
- <exception cref="T:System.ArgumentNullException">StringEncoding must not be null</exception>
- </member>
- <member name="M:S7.Net.Types.S7String.FromByteArray(System.Byte[])">
- <summary>
- Converts S7 bytes to a string
- </summary>
- <param name="bytes"></param>
- <returns></returns>
- </member>
- <member name="M:S7.Net.Types.S7String.ToByteArray(System.String,System.Int32)">
- <summary>
- Converts a <see cref="T:string"/> to S7 string with 2-byte header.
- </summary>
- <param name="value">The string to convert to byte array.</param>
- <param name="reservedLength">The length (in characters) allocated in PLC for the string.</param>
- <returns>A <see cref="T:byte[]" /> containing the string header and string value with a maximum length of <paramref name="reservedLength"/> + 2.</returns>
- </member>
- <member name="M:S7.Net.Types.S7StringAttribute.#ctor(S7.Net.Types.S7StringType,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:S7.Net.Types.S7StringAttribute"/> class.
- </summary>
- <param name="type">The string type.</param>
- <param name="reservedLength">Reserved length of the string in characters.</param>
- <exception cref="T:System.ArgumentException">Please use a valid value for the string type</exception>
- </member>
- <member name="P:S7.Net.Types.S7StringAttribute.Type">
- <summary>
- Gets the type of the string.
- </summary>
- <value>
- The string type.
- </value>
- </member>
- <member name="P:S7.Net.Types.S7StringAttribute.ReservedLength">
- <summary>
- Gets the reserved length of the string in characters.
- </summary>
- <value>
- The reserved length of the string in characters.
- </value>
- </member>
- <member name="P:S7.Net.Types.S7StringAttribute.ReservedLengthInBytes">
- <summary>
- Gets the reserved length in bytes.
- </summary>
- <value>
- The reserved length in bytes.
- </value>
- </member>
- <member name="T:S7.Net.Types.S7StringType">
- <summary>
- String type.
- </summary>
- </member>
- <member name="F:S7.Net.Types.S7StringType.S7String">
- <summary>
- ASCII string.
- </summary>
- </member>
- <member name="F:S7.Net.Types.S7StringType.S7WString">
- <summary>
- Unicode string.
- </summary>
- </member>
- <member name="T:S7.Net.Types.S7WString">
- <summary>
- Contains the methods to convert from S7 wstrings to C# strings
- An S7 WString has a preceding 4 byte header containing its capacity and length
- </summary>
- </member>
- <member name="M:S7.Net.Types.S7WString.FromByteArray(System.Byte[])">
- <summary>
- Converts S7 bytes to a string
- </summary>
- <param name="bytes"></param>
- <returns></returns>
- </member>
- <member name="M:S7.Net.Types.S7WString.ToByteArray(System.String,System.Int32)">
- <summary>
- Converts a <see cref="T:string"/> to S7 wstring with 4-byte header.
- </summary>
- <param name="value">The string to convert to byte array.</param>
- <param name="reservedLength">The length (in characters) allocated in PLC for the string.</param>
- <returns>A <see cref="T:byte[]" /> containing the string header and string value with a maximum length of <paramref name="reservedLength"/> + 4.</returns>
- </member>
- <member name="T:S7.Net.Types.Single">
- <summary>
- Contains the conversion methods to convert Real from S7 plc to C# float.
- </summary>
- </member>
- <member name="M:S7.Net.Types.Single.FromByteArray(System.Byte[])">
- <summary>
- Converts a S7 Real (4 bytes) to float
- </summary>
- </member>
- <member name="M:S7.Net.Types.Single.FromDWord(System.Int32)">
- <summary>
- Converts a S7 DInt to float
- </summary>
- </member>
- <member name="M:S7.Net.Types.Single.FromDWord(System.UInt32)">
- <summary>
- Converts a S7 DWord to float
- </summary>
- </member>
- <member name="M:S7.Net.Types.Single.ToByteArray(System.Single)">
- <summary>
- Converts a double to S7 Real (4 bytes)
- </summary>
- </member>
- <member name="M:S7.Net.Types.Single.ToByteArray(System.Single[])">
- <summary>
- Converts an array of float to an array of bytes
- </summary>
- </member>
- <member name="M:S7.Net.Types.Single.ToArray(System.Byte[])">
- <summary>
- Converts an array of S7 Real to an array of float
- </summary>
- </member>
- <member name="T:S7.Net.Types.String">
- <summary>
- Contains the methods to convert from S7 Array of Chars (like a const char[N] C-String) to C# strings
- </summary>
- </member>
- <member name="M:S7.Net.Types.String.ToByteArray(System.String,System.Int32)">
- <summary>
- Converts a string to <paramref name="reservedLength"/> of bytes, padded with 0-bytes if required.
- </summary>
- <param name="value">The string to write to the PLC.</param>
- <param name="reservedLength">The amount of bytes reserved for the <paramref name="value"/> in the PLC.</param>
- </member>
- <member name="M:S7.Net.Types.String.FromByteArray(System.Byte[])">
- <summary>
- Converts S7 bytes to a string
- </summary>
- <param name="bytes"></param>
- <returns></returns>
- </member>
- <member name="T:S7.Net.Types.StringEx">
- <inheritdoc cref="T:S7.Net.Types.S7String"/>
- </member>
- <member name="M:S7.Net.Types.StringEx.FromByteArray(System.Byte[])">
- <inheritdoc cref="M:S7.Net.Types.S7String.FromByteArray(System.Byte[])"/>
- </member>
- <member name="M:S7.Net.Types.StringEx.ToByteArray(System.String,System.Int32)">
- <inheritdoc cref="M:S7.Net.Types.S7String.ToByteArray(System.String,System.Int32)"/>
- </member>
- <member name="T:S7.Net.Types.Struct">
- <summary>
- Contains the method to convert a C# struct to S7 data types
- </summary>
- </member>
- <member name="M:S7.Net.Types.Struct.GetStructSize(System.Type)">
- <summary>
- Gets the size of the struct in bytes.
- </summary>
- <param name="structType">the type of the struct</param>
- <returns>the number of bytes</returns>
- </member>
- <member name="M:S7.Net.Types.Struct.FromBytes(System.Type,System.Byte[])">
- <summary>
- Creates a struct of a specified type by an array of bytes.
- </summary>
- <param name="structType">The struct type</param>
- <param name="bytes">The array of bytes</param>
- <returns>The object depending on the struct type or null if fails(array-length != struct-length</returns>
- </member>
- <member name="M:S7.Net.Types.Struct.ToBytes(System.Object)">
- <summary>
- Creates a byte array depending on the struct type.
- </summary>
- <param name="structValue">The struct object</param>
- <returns>A byte array or null if fails.</returns>
- </member>
- <member name="T:S7.Net.Types.Timer">
- <summary>
- Converts the Timer data type to C# data type
- </summary>
- </member>
- <member name="M:S7.Net.Types.Timer.FromByteArray(System.Byte[])">
- <summary>
- Converts the timer bytes to a double
- </summary>
- </member>
- <member name="M:S7.Net.Types.Timer.ToByteArray(System.UInt16)">
- <summary>
- Converts a ushort (UInt16) to an array of bytes formatted as time
- </summary>
- </member>
- <member name="M:S7.Net.Types.Timer.ToByteArray(System.UInt16[])">
- <summary>
- Converts an array of ushorts (Uint16) to an array of bytes formatted as time
- </summary>
- </member>
- <member name="M:S7.Net.Types.Timer.ToArray(System.Byte[])">
- <summary>
- Converts an array of bytes formatted as time to an array of doubles
- </summary>
- <param name="bytes"></param>
- <returns></returns>
- </member>
- <member name="T:S7.Net.Types.TimeSpan">
- <summary>
- Contains the methods to convert between <see cref="T:System.TimeSpan"/> and S7 representation of TIME values.
- </summary>
- </member>
- <member name="F:S7.Net.Types.TimeSpan.SpecMinimumTimeSpan">
- <summary>
- The minimum <see cref="T:System.TimeSpan"/> value supported by the specification.
- </summary>
- </member>
- <member name="F:S7.Net.Types.TimeSpan.SpecMaximumTimeSpan">
- <summary>
- The maximum <see cref="T:System.TimeSpan"/> value supported by the specification.
- </summary>
- </member>
- <member name="M:S7.Net.Types.TimeSpan.FromByteArray(System.Byte[])">
- <summary>
- Parses a <see cref="T:System.TimeSpan"/> value from bytes.
- </summary>
- <param name="bytes">Input bytes read from PLC.</param>
- <returns>A <see cref="T:System.TimeSpan"/> object representing the value read from PLC.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the length of
- <paramref name="bytes"/> is not 4 or any value in <paramref name="bytes"/>
- is outside the valid range of values.</exception>
- </member>
- <member name="M:S7.Net.Types.TimeSpan.ToArray(System.Byte[])">
- <summary>
- Parses an array of <see cref="T:System.TimeSpan"/> values from bytes.
- </summary>
- <param name="bytes">Input bytes read from PLC.</param>
- <returns>An array of <see cref="T:System.TimeSpan"/> objects representing the values read from PLC.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the length of
- <paramref name="bytes"/> is not a multiple of 4 or any value in
- <paramref name="bytes"/> is outside the valid range of values.</exception>
- </member>
- <member name="M:S7.Net.Types.TimeSpan.ToByteArray(System.TimeSpan)">
- <summary>
- Converts a <see cref="T:System.TimeSpan"/> value to a byte array.
- </summary>
- <param name="timeSpan">The TimeSpan value to convert.</param>
- <returns>A byte array containing the S7 date time representation of <paramref name="timeSpan"/>.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the value of
- <paramref name="timeSpan"/> is before <see cref="P:SpecMinimumTimeSpan"/>
- or after <see cref="P:SpecMaximumTimeSpan"/>.</exception>
- </member>
- <member name="M:S7.Net.Types.TimeSpan.ToByteArray(System.TimeSpan[])">
- <summary>
- Converts an array of <see cref="T:System.TimeSpan"/> values to a byte array.
- </summary>
- <param name="timeSpans">The TimeSpan values to convert.</param>
- <returns>A byte array containing the S7 date time representations of <paramref name="timeSpans"/>.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when any value of
- <paramref name="timeSpans"/> is before <see cref="P:SpecMinimumTimeSpan"/>
- or after <see cref="P:SpecMaximumTimeSpan"/>.</exception>
- </member>
- <member name="M:S7.Net.Types.TypeHelper.ToByteArray``1(``0[],System.Func{``0,System.Byte[]})">
- <summary>
- Converts an array of T to an array of bytes
- </summary>
- </member>
- <member name="M:S7.Net.Types.TypeHelper.ToArray``1(System.Byte[],System.Func{System.Byte[],``0})">
- <summary>
- Converts an array of T repesented as S7 binary data to an array of T
- </summary>
- </member>
- <member name="T:S7.Net.Types.Word">
- <summary>
- Contains the conversion methods to convert Words from S7 plc to C#.
- </summary>
- </member>
- <member name="M:S7.Net.Types.Word.FromByteArray(System.Byte[])">
- <summary>
- Converts a word (2 bytes) to ushort (UInt16)
- </summary>
- </member>
- <member name="M:S7.Net.Types.Word.FromBytes(System.Byte,System.Byte)">
- <summary>
- Converts 2 bytes to ushort (UInt16)
- </summary>
- </member>
- <member name="M:S7.Net.Types.Word.ToByteArray(System.UInt16)">
- <summary>
- Converts a ushort (UInt16) to word (2 bytes)
- </summary>
- </member>
- <member name="M:S7.Net.Types.Word.ToByteArray(System.UInt16[])">
- <summary>
- Converts an array of ushort (UInt16) to an array of bytes
- </summary>
- </member>
- <member name="M:S7.Net.Types.Word.ToArray(System.Byte[])">
- <summary>
- Converts an array of bytes to an array of ushort
- </summary>
- </member>
- </members>
- </doc>
|