Serial events (#337)
* added "serial->on data received" * updated info * updated docs * added readline to read entire buffer * lazy initialize of serial buffers * init async on event * updated docs
This commit is contained in:
		
				
					committed by
					
						 Peli de Halleux
						Peli de Halleux
					
				
			
			
				
	
			
			
			
						parent
						
							5d861e1e6d
						
					
				
				
					commit
					d4220593b0
				
			| @@ -7,8 +7,11 @@ serial.writeLine(""); | ||||
| serial.writeNumber(0); | ||||
| serial.writeValue("x", 0); | ||||
| serial.writeString(""); | ||||
| serial.readUntil(","); | ||||
| serial.readLine(); | ||||
| serial.readString(); | ||||
| serial.redirect(SerialPin.P0, SerialPin.P0, BaudRate.BaudRate115200); | ||||
| serial.onDataReceived(",", () => {}) | ||||
| ``` | ||||
|  | ||||
| ### See Also | ||||
|   | ||||
							
								
								
									
										29
									
								
								docs/reference/serial/on-data-received.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										29
									
								
								docs/reference/serial/on-data-received.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,29 @@ | ||||
| # Serial On Data Received | ||||
|  | ||||
| Registers an event to be fired when one of the delimiter is matched. | ||||
|  | ||||
|  | ||||
| ```sig | ||||
| serial.onDataReceived(",", () => {}) | ||||
| ``` | ||||
|  | ||||
| ### Parameters | ||||
|  | ||||
| * `delimiters` is a [string](/reference/types/string) containing any of the character to match | ||||
|  | ||||
| ### Example | ||||
|  | ||||
| Read values separated by `,`: | ||||
|  | ||||
| ```blocks | ||||
| serial.onDataReceived(serial.delimiters(Delimiters.Comma), () => { | ||||
|     basic.showString(serial.readUntil(serial.delimiters(Delimiters.Comma))) | ||||
| }) | ||||
| ``` | ||||
|  | ||||
| ### See also | ||||
|  | ||||
| [serial](/device/serial), | ||||
| [serial write line](/reference/serial/write-line), | ||||
| [serial write value](/reference/serial/write-value) | ||||
|  | ||||
							
								
								
									
										27
									
								
								docs/reference/serial/read-string.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										27
									
								
								docs/reference/serial/read-string.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,27 @@ | ||||
| # Serial Read String | ||||
|  | ||||
| Read the buffered serial data as a string | ||||
|  | ||||
| ```sig | ||||
| serial.readString(); | ||||
| ``` | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| * a [string](/reference/types/string) containing input from the serial port. Empty if no data available. | ||||
|  | ||||
| ### Example | ||||
|  | ||||
| The following program scrolls text on the screen as it arrives from serial. | ||||
|  | ||||
| ```blocks | ||||
| basic.forever(() => { | ||||
|     basic.showString(serial.readString()); | ||||
| }); | ||||
| ``` | ||||
|  | ||||
| ### See also | ||||
|  | ||||
| [serial](/device/serial), | ||||
| [serial write line](/reference/serial/write-line), | ||||
| [serial write value](/reference/serial/write-value) | ||||
		Reference in New Issue
	
	Block a user