Admin at 18:49, 17 January 2017

2017-01-17T18:49:07Z

Admin at 17:21, 11 February 2013

2013-02-11T17:21:35Z

Admin: Created page with "= Action = Reads a byte from the hardware or software UART. Reads data from a file opened in BINARY mode. &n..."

2013-02-11T17:20:36Z

Created page with "= Action = Reads a byte from the hardware or software UART. Reads data from a file opened in BINARY mode. &n..."

New page

= Action =

Reads a byte from the hardware or software UART.

Reads data from a file opened in BINARY mode.

 

 

= Syntax =

GET #channel, var

GET #channel, var , [pos] [, length]

 

 

= Remarks =

GET in combination with the software/hardware UART reads one byte from the UART.

GET in combination with the AVR-DOS file system is very flexible and versatile. It works on files opened in BINARY mode and you can reads all data types.

 
<div style="padding: 0px; margin: 0px 0px 0px 4px;">
{| width="614" cellspacing="0" cellpadding="1" border="1" style="border: 2px solid rgb(0, 0, 0); border-spacing: 0px; border-collapse: collapse;"
|- style="vertical-align: top;"
| valign="top" width="14%" style="width: 83px; border: 1px solid rgb(0, 0, 0);" |
#channel

| valign="top" width="87%" style="width: 522px; border: 1px solid rgb(0, 0, 0);" |
A channel number, which identifies an opened file. This can be a hard coded constant or a variable.

|- style="vertical-align: top;"
| valign="top" width="14%" style="width: 83px; border: 1px solid rgb(0, 0, 0);" |
Var

| valign="top" width="87%" style="width: 522px; border: 1px solid rgb(0, 0, 0);" |
The variable or variable array that will be assigned with the data from the file

|- style="vertical-align: top;"
| valign="top" width="14%" style="width: 83px; border: 1px solid rgb(0, 0, 0);" |
Pos

| valign="top" width="87%" style="width: 522px; border: 1px solid rgb(0, 0, 0);" |
This is an optional parameter that may be used to specify the position where the reading must start from. This must be a long variable.

|- style="vertical-align: top;"
| valign="top" width="14%" style="width: 83px; border: 1px solid rgb(0, 0, 0);" |
Length

| valign="top" width="87%" style="width: 522px; border: 1px solid rgb(0, 0, 0);" |
This is an optional parameter that may be used to specify how many bytes must be read from the file.

|}
</div>
 

By default you only need to provide the variable name. When the variable is a byte, 1 byte will be read. When the variable is a word or integer, 2 bytes will be read. When the variable is a long or single, 4 bytes will be read. When the variable is a string, the number of bytes that will be read is equal to the dimensioned size of the string. DIM S as string * 10 , would read 10 bytes.

 

Note that when you specify the length for a string, the maximum length is 254. The maximum length for a non-string array is 65535.

 

 

= Partial Example =

GET #1 , var ,,2  ' read 2 bytes, start at current position

GET #1, var , PS ' start at position stored in long PS

GET #1, var , PS, 2 ' start at position stored in long PS and read 2 bytes

 

 

= See also =

[http://avrhelp.mcselec.com/initfilesystem.htm INITFILESYSTEM] , [http://avrhelp.mcselec.com/open.htm OPEN] , [http://avrhelp.mcselec.com/close.htm CLOSE], [http://avrhelp.mcselec.com/flush.htm FLUSH] , [http://avrhelp.mcselec.com/print.htm PRINT], [http://avrhelp.mcselec.com/line_input.htm LINE INPUT], [http://avrhelp.mcselec.com/loc.htm LOC], [http://avrhelp.mcselec.com/lof.htm LOF] , [http://avrhelp.mcselec.com/eof.htm EOF] , [http://avrhelp.mcselec.com/freefile.htm FREEFILE] , [http://avrhelp.mcselec.com/fileattr.htm FILEATTR] , [http://avrhelp.mcselec.com/seek.htm SEEK] , [http://avrhelp.mcselec.com/bsave.htm BSAVE] ,[http://avrhelp.mcselec.com/bload.htm BLOAD] , [http://avrhelp.mcselec.com/kill.htm KILL] , [http://avrhelp.mcselec.com/diskfree.htm DISKFREE] , [http://avrhelp.mcselec.com/disksize.htm DISKSIZE] , [http://avrhelp.mcselec.com/put.htm PUT] , [http://avrhelp.mcselec.com/filedate.htm FILEDATE] , [http://avrhelp.mcselec.com/filetime.htm FILETIME] , [http://avrhelp.mcselec.com/filedatetime.htm FILEDATETIME] , [http://avrhelp.mcselec.com/dir.htm DIR] , [http://avrhelp.mcselec.com/filelen.htm FILELEN] , [http://avrhelp.mcselec.com/write.htm WRITE] , [http://avrhelp.mcselec.com/input.htm INPUT]

 

 

 

= ASM =
<div style="padding: 0px; margin: 0px;">
{| width="628" cellspacing="0" cellpadding="1" border="1" style="border: 2px solid rgb(0, 0, 0); border-spacing: 0px; border-collapse: collapse;"
|- style="vertical-align: top;"
| valign="top" width="100%" style="width: 481px; border: 1px solid rgb(0, 0, 0);" |
current position

| valign="top" width="100%" style="width: 138px; border: 1px solid rgb(0, 0, 0);" |
goto new position first

|- style="vertical-align: top;"
| valign="top" width="100%" style="width: 481px; border: 1px solid rgb(0, 0, 0);" |
Byte:

| valign="top" width="100%" style="width: 138px; border: 1px solid rgb(0, 0, 0);" |
 

|- style="vertical-align: top;"
| valign="top" width="100%" style="width: 481px; border: 1px solid rgb(0, 0, 0);" |
_FileGetRange_1

 

Input:

 

r24: File number

 

X: Pointer to variable

 

T-Flag cleared

| valign="top" width="100%" style="width: 138px; border: 1px solid rgb(0, 0, 0);" |
_FileGetRange_1

 

Input:

 

r24: File number

 

X: Pointer to variable

 

r16-19 (A): New position (1-based)

 

T-Flag Set

|- style="vertical-align: top;"
| valign="top" width="100%" style="width: 481px; border: 1px solid rgb(0, 0, 0);" |
Word/Integer:

| valign="top" width="100%" style="width: 138px; border: 1px solid rgb(0, 0, 0);" |
 

|- style="vertical-align: top;"
| valign="top" width="100%" style="width: 481px; border: 1px solid rgb(0, 0, 0);" |
_FileGetRange_2

 

Input:

 

r24: File number

 

X: Pointer to variable

 

T-Flag cleared

| valign="top" width="100%" style="width: 138px; border: 1px solid rgb(0, 0, 0);" |
_FileGetRange_2

 

Input:

 

r24: File number

 

X: Pointer to variable

 

r16-19 (A): New position (1-based)

 

T-Flag Set

|- style="vertical-align: top;"
| valign="top" width="100%" style="width: 481px; border: 1px solid rgb(0, 0, 0);" |
Long/Single:

| valign="top" width="100%" style="width: 138px; border: 1px solid rgb(0, 0, 0);" |
 

|- style="vertical-align: top;"
| valign="top" width="100%" style="width: 481px; border: 1px solid rgb(0, 0, 0);" |
_FileGetRange_4

 

Input:

 

r24: File number

 

X: Pointer to variable

 

T-Flag cleared

| valign="top" width="100%" style="width: 138px; border: 1px solid rgb(0, 0, 0);" |
_FileGetRange_4

 

Input:

 

r24: File number

 

X: Pointer to variable

 

r16-19 (A): New position (1-based)

 

T-Flag Set

|- style="vertical-align: top;"
| valign="top" width="100%" style="width: 481px; border: 1px solid rgb(0, 0, 0);" |
String (<= 255 Bytes) with fixed length

| valign="top" width="100%" style="width: 138px; border: 1px solid rgb(0, 0, 0);" |
 

|- style="vertical-align: top;"
| valign="top" width="100%" style="width: 481px; border: 1px solid rgb(0, 0, 0);" |
_FileGetRange_Bytes

 

Input:

 

r24: File number

 

r20: Count of Bytes

 

X: Pointer to variable

 

T-Flag cleared

| valign="top" width="100%" style="width: 138px; border: 1px solid rgb(0, 0, 0);" |
_FileGetRange_Bytes

 

Input:

 

r24: File number

 

r20: Count of bytes

 

X: Pointer to variable

 

r16-19 (A): New position (1-based)

 

T-Flag Set

|- style="vertical-align: top;"
| valign="top" width="100%" style="width: 481px; border: 1px solid rgb(0, 0, 0);" |
Array (> 255 Bytes) with fixed length

| valign="top" width="100%" style="width: 138px; border: 1px solid rgb(0, 0, 0);" |
 

|- style="vertical-align: top;"
| valign="top" width="100%" style="width: 481px; border: 1px solid rgb(0, 0, 0);" |
_FileGetRange

 

Input:

 

r24: File number

 

r20/21: Count of Bytes

 

X: Pointer to variable

 

T-Flag cleared

| valign="top" width="100%" style="width: 138px; border: 1px solid rgb(0, 0, 0);" |
_FileGetRange

 

Input:

 

r24: File number

 

r20/21: Count of bytes

 

X: Pointer to variable

 

r16-19 (A): New position (1-based)

 

T-Flag Set

|}
</div>
 

 

Output from all kind of usage:

r25: Error Code

C-Flag on Error

X: requested info

 

 

= Partial Example =

 <source lang="bascomavr">
'for the binary file demo we need some variables of different types
Dim B As Byte , W As Word , L As Long , Sn As Single , Ltemp As Long
Dim Stxt As String * 10
B = 1 : W = 50000 : L = 12345678 : Sn = 123.45 : Stxt = "test"

'open the file in BINARY mode
Open "test.biN"for Binary As #2
Put#2 , B ' write a byte
Put#2 , W ' write a word
Put#2 , L ' write a long
Ltemp = Loc(#2) + 1 ' get the position of the next byte
Print Ltemp ; " LOC" ' store the location of the file pointer
Print Seek(#2) ; " = LOC+1"

Print Lof(#2) ; " length of file"
Print Fileattr(#2) ; " file mode" ' should be 32 for binary
Put #2 , Sn ' write a single
Put #2 , Stxt ' write a string

Flush #2 ' flush to disk
Close #2

'now open the file again and write only the single
Open "test.bin" For Binary As #2
L = 1 'specify the file position
B = Seek(#2 , L) ' reset is the same as using SEEK #2,L
Get#2 , B ' get the byte
Get#2 , W ' get the word
Get#2 , L ' get the long
Get#2 , Sn ' get the single
Get#2 , Stxt ' get the string
Close #2
</source> {{Languages}}

[[Category:BASCOM Language Reference]]

@@ Line 68: / Line 68: @@
 <span style="font-family: Arial;">&nbsp;</span>
-<span style="font-family: Arial;">&nbsp;</span>
+In BASCOM-8051, GET was implemented to read only from the UART. While BASCOM-AVR supports GET for the UART, its primary purpose is to read from files with AVR-DOS. For the UART, GET is limited to read 1 byte, just like WAITKEY.&nbsp;
 = <span class="f_Header">Partial Example</span> =

@@ Line 84: / Line 84: @@
 = <span class="f_Header">See also</span> =
-[http://avrhelp.mcselec.com/initfilesystem.htm INITFILESYSTEM]&nbsp;,&nbsp;[http://avrhelp.mcselec.com/open.htm OPEN]&nbsp;,&nbsp;[http://avrhelp.mcselec.com/close.htm CLOSE],&nbsp;[http://avrhelp.mcselec.com/flush.htm FLUSH]&nbsp;,&nbsp;[http://avrhelp.mcselec.com/print.htm PRINT],&nbsp;[http://avrhelp.mcselec.com/line_input.htm LINE INPUT],&nbsp;[http://avrhelp.mcselec.com/loc.htm LOC],&nbsp;[http://avrhelp.mcselec.com/lof.htm LOF]&nbsp;,&nbsp;[http://avrhelp.mcselec.com/eof.htm EOF]&nbsp;,&nbsp;[http://avrhelp.mcselec.com/freefile.htm FREEFILE]&nbsp;,&nbsp;[http://avrhelp.mcselec.com/fileattr.htm FILEATTR]&nbsp;,&nbsp;[http://avrhelp.mcselec.com/seek.htm SEEK]&nbsp;,&nbsp;[http://avrhelp.mcselec.com/bsave.htm BSAVE]&nbsp;,[http://avrhelp.mcselec.com/bload.htm BLOAD]&nbsp;,&nbsp;[http://avrhelp.mcselec.com/kill.htm KILL]&nbsp;,&nbsp;[http://avrhelp.mcselec.com/diskfree.htm DISKFREE]&nbsp;,&nbsp;[http://avrhelp.mcselec.com/disksize.htm DISKSIZE]&nbsp;,&nbsp;[http://avrhelp.mcselec.com/put.htm PUT]&nbsp;,&nbsp;[http://avrhelp.mcselec.com/filedate.htm FILEDATE]&nbsp;,&nbsp;[http://avrhelp.mcselec.com/filetime.htm FILETIME]&nbsp;,&nbsp;[http://avrhelp.mcselec.com/filedatetime.htm FILEDATETIME]&nbsp;,&nbsp;[http://avrhelp.mcselec.com/dir.htm DIR]&nbsp;,&nbsp;[http://avrhelp.mcselec.com/filelen.htm FILELEN]&nbsp;,&nbsp;[http://avrhelp.mcselec.com/write.htm WRITE]&nbsp;,&nbsp;[http://avrhelp.mcselec.com/input.htm INPUT]
+[[INITFILESYSTEM]] , [[OPEN]] , [[CLOSE]], [[FLUSH]] , [[PRINT]], [[LINE INPUT]], [[LOC]], [[LOF]] , [[EOF]] , [[FREEFILE]] , [[FILEATTR]] , [[SEEK]] , [[BSAVE]] ,[[BLOAD]] , [[KILL]] , [[DISKFREE]] , [[DISKSIZE]] , [[PUT]] , [[FILEDATE]] , [[FILETIME]] , [[FILEDATETIME]] , [[DIR]] , [[FILELEN]] , [[WRITE]] , [[INPUT]]
 <span style="font-family: Arial;">&nbsp;</span>

GET - Revision history

Admin at 18:49, 17 January 2017

Admin at 17:21, 11 February 2013

Admin: Created page with "= Action = Reads a byte from the hardware or software UART. Reads data from a file opened in BINARY mode. &n..."