https://wiki.nxez.com/ 2026-04-09T04:34:47+08:00 https://wiki.nxez.com/ https://wiki.nxez.com/lib/tpl/dokuwiki/images/favicon.ico text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:clientavailable?rev=1482675304&do=diff Ethernet : Client class available() Description Returns the number of bytes available for reading (that is, the amount of data that has been written to the client by the server it is connected to). available() inherits from the Stream utility class. Syntax text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:clientconnect?rev=1482675304&do=diff Ethernet : Client class connect() Description Connects to a specified IP address and port. The return value indicates success or failure. Also supports DNS lookups when using a domain name. Syntax client.connect(ip, port) client.connect(URL, port) Parameters text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:clientconnected?rev=1482675304&do=diff Ethernet : Client class connected() Description Whether or not the client is connected. Note that a client is considered connected if the connection has been closed but there is still unread data. Syntax client.connected() Parameters none Returns Returns true if the client is connected, false if not. text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:clientconstructor?rev=1482675304&do=diff Ethernet : Client class Client Description Client is the base class for all Ethernet client based calls. It is not called directly, but invoked whenever you use a function that relies on it. Functions * EthernetClient() * connected() * connect() * text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:clientflush?rev=1482675304&do=diff Ethernet : Client class flush() Discard any bytes that have been written to the client but not yet read. flush() inherits from the Stream utility class. Syntax client.flush() Parameters none Returns none Reference Home text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:clientprint?rev=1482675304&do=diff Ethernet : Client class print() Description Print data to the server that a client is connected to. Prints numbers as a sequence of digits, each an ASCII character (e.g. the number 123 is sent as the three characters '1', '2', '3'). Syntax client.print(data) text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:clientprintln?rev=1482675304&do=diff Ethernet : Client class println() Description Print data, followed by a carriage return and newline, to the server a client is connected to. Prints numbers as a sequence of digits, each an ASCII character (e.g. the number 123 is sent as the three characters '1', '2', '3'). text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:clientread?rev=1482675304&do=diff Ethernet : Client class read() Read the next byte received from the server the client is connected to (after the last call to read()). read() inherits from the Stream utility class. Syntax client.read() Parameters none Returns The next byte (or character), or -1 if none is available. text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:clientstop?rev=1482675304&do=diff Ethernet : Client class stop() Description Disconnect from the server. Syntax client.stop() Parameters none Returns none Reference Home text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:clientwrite?rev=1482675304&do=diff Ethernet : Client class write() Description Write data to the server the client is connected to. Syntax client.write(data) Parameters data: the byte or char to write Returns byte: the number of characters written. it is not necessary to read this value. text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:eeprom?rev=1482675304&do=diff EEPROM Library The microcontroller on the Arduino board has EEPROM: memory whose values are kept when the board is turned off (like a tiny hard drive). This library enables you to read and write those bytes. The microcontrollers on the various Arduino boards have different amounts of EEPROM: 1024 bytes on the ATmega328, 512 bytes on the ATmega168 and ATmega8, 4 KB (4096 bytes) on the ATmega1280 and ATmega2560. text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:eepromread?rev=1482675304&do=diff EEPROM read() Description Reads a byte from the EEPROM. Locations that have never been written to have the value of 255. Syntax EEPROM.read(address) Parameters address: the location to read from, starting from 0 (int) Returns the value stored in that location (byte) text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:eepromwrite?rev=1482675304&do=diff EEPROM write() Description Write a byte to the EEPROM. Syntax EEPROM.write(address, value) Parameters address: the location to write to, starting from 0 (int) value: the value to write, from 0 to 255 (byte) Returns none Note An EEPROM write takes 3.3 ms to complete. The EEPROM memory has a specified life of 100,000 write/erase cycles, so you may need to be careful about how often you write to it. text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:ethernet?rev=1482675304&do=diff Ethernet library With the Arduino Ethernet Shield, this library allows an Arduino board to connect to the internet. It can serve as either a server accepting incoming connections or a client making outgoing ones. The library supports up to four concurrent connection (incoming or outgoing or a combination). text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:ethernetbegin?rev=1482675304&do=diff Ethernet Ethernet.begin() Description Initializes the ethernet library and network settings. With version 1.0, the library supports DHCP. Using Ethernet.begin(mac) with the proper network setup, the Ethernet shield will automatically obtain an IP address. This increases the sketch size significantly. text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:ethernetclient?rev=1482675304&do=diff Ethernet : EthernetClient EthernetClient() Description Creates a client which can connect to a specified internet IP address and port (defined in the client.connect() function). Syntax EthernetClient() Parameters None Example #include <Ethernet.h> #include <SPI.h> byte mac[] = { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED }; byte ip[] = { 10, 0, 0, 177 }; byte server[] = { 64, 233, 187, 99 }; // Google EthernetClient client; void setup() { Ethernet.begin(mac, ip); Serial.begin(9600); … text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:ethernetipaddress?rev=1482675304&do=diff Ethernet : IPAddress class IPAddress() Description Defines an IP address. It can be used to declare both local and remote addresses. Syntax IPAddress(address); Parameters address: a comma delimited list representing the address (4 bytes, ex. 192, 168, 1, 1) text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:ethernetlocalip?rev=1482675304&do=diff Ethernet Ethernet.localIP() Description Obtains the IP address of the Ethernet shield. Useful when the address is auto assigned through DHCP. Syntax Ethernet.localIP(); Parameters none Returns the IP address Example #include <SPI.h> #include <Ethernet.h> // Enter a MAC address for your controller below. // Newer Ethernet shields have a MAC address printed on a sticker on the shield byte mac[] = { 0x00, 0xAA, 0xBB, 0xCC, 0xDE, 0x02 }; // Initialize the Ethernet client library //… text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:ethernetmaintain?rev=1482675304&do=diff Ethernet Ethernet.maintain() Description Allows for the renewal of DHCP leases. When assigned an IP address via DHCP, ethernet devices are given a lease on the address for an amount of time. With Ethernet.maintain(), it is possible to request a renewal from the DHCP server. Depending on the server's configuration, you may receive the same address, a new one, or none at all. text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:ethernetserver?rev=1482675304&do=diff Ethernet : EthernetServer EthernetServer() Description Create a server that listens for incoming connections on the specified port. Syntax Server(port); Parameters port: the port to listen on (int) Returns None Example #include <SPI.h> #include <Ethernet.h> // network configuration. gateway and subnet are optional. // the media access control (ethernet hardware) address for the shield: byte mac[] = { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED }; //the IP address for the shield: byte ip… text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:ethernetudpavailable?rev=1482675304&do=diff Ethernet : UDP.available() UDP.available() Description Get the number of bytes (characters) available for reading from the buffer. This is data that's already arrived. This function can only be successfully called after UDP.parsePacket(). available() inherits from the Stream utility class. text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:ethernetudpbegin?rev=1482675304&do=diff Ethernet : UDP.begin() UDP.begin() Description Initializes the ethernet UDP library and network settings. Syntax EthernetUDP.begin(localPort); Parameters localPort: the local port to listen on (int) Returns None Example #include <SPI.h> #include <Ethernet.h> #include <EthernetUdp.h> // Enter a MAC address and IP address for your controller below. // The IP address will be dependent on your local network: byte mac[] = { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED }; IPAddress ip… text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:ethernetudpbeginpacket?rev=1482675304&do=diff Ethernet : UDP.beginPacket() UDP.beginPacket() Description Starts a connection to write UDP data to the remote connection Syntax UDP.beginPacket(remoteIP, remotePort); Parameters remoteIP: the IP address of the remote connection (4 bytes) remotePort: the port of the remote connection (int) text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:ethernetudpendpacket?rev=1482675304&do=diff Ethernet : UDP.endPacket() UDP.endPacket() Description Called after writing UDP data to the remote connection. Syntax UDP.endPacket(); Parameters None Returns None Example #include <SPI.h> #include <Ethernet.h> #include <EthernetUdp.h> // Enter a MAC address and IP address for your controller below. // The IP address will be dependent on your local network: byte mac[] = { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED }; IPAddress ip(192, 168, 1, 177); unsigned int localPort = 888… text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:ethernetudpparsepacket?rev=1482675304&do=diff Ethernet：UDP.parsePacket() parsePacket() Description Checks for the presence of a UDP packet, and reports the size. parsePacket() must be called before reading the buffer with UDP.read(). Syntax UDP.parsePacket(); Parameters None Returns int: the size of a received UDP packet text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:ethernetudpread?rev=1482675304&do=diff Ethernet : UDP.read() UDP.read() Description Reads UDP data from the specified buffer. If no arguments are given, it will return the next character in the buffer. This function can only be successfully called after UDP.parsePacket(). Syntax UDP.read(); text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:ethernetudpremoteip?rev=1482675304&do=diff Ethernet : UDP.remoteIP() UDP.remoteIP() Description Gets the IP address of the remote connection. This function must be called after UDP.parsePacket(). Syntax UDP.remoteIP(); Parameters None Returns 4 bytes : the IP address of the remote connection text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:ethernetudpremoteport?rev=1482675304&do=diff Ethernet : UDP.remotePort() UDP.remotePort() Description Gets the port of the remote UDP connection. This function must be called after UDP.parsePacket(). Syntax UDP.remotePort(); Parameters None Returns int : the port of the UDP connection to a remote host text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:ethernetudpwrite?rev=1482675304&do=diff Ethernet : UDP.write() UDP.write() Description Writes UDP data to the remote connection. Must be wrapped between beginPacket() and endPacket(). beginPacket() initializes the packet of data, it is not sent until endPacket() is called. Syntax UDP.write(message); text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:fileavailable?rev=1482675304&do=diff SD : File class available() Check if there are any bytes available for reading from the file. available() inherits from the Stream utility class. Syntax file.available() Parameters file: an instance of the File class (returned by SD.open()) Returns text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:fileclose?rev=1482675304&do=diff SD : File class close() Close the file, and ensure that any data written to it is physically saved to the SD card. Syntax file.close() Parameters file: an instance of the File class (returned by SD.open()) Returns none See Also * SD: open() text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:fileflush?rev=1482675304&do=diff SD : File class flush() Ensures that any bytes written to the file are physically saved to the SD card. This is done automatically when the file is closed. flush() inherits from the Stream utility class. Syntax file.flush() Parameters file: an instance of the File class (returned by SD.open()) text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:fileisdirectory?rev=1482675304&do=diff SD : File class isDirectory() Directories (or folders) are special kinds of files, this function reports if the current file is a directory or not. Syntax file.isDirectory() Parameters file: an instance of the File class (returned by file.open() text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:fileopennextfile?rev=1482675304&do=diff SD : File class openNextFile() Reports the next file or folder in a directory. Syntax file.openNextFile() Parameters file: an instance of the File class that is a directory Returns char : the next file or folder in the path Example #include <SD.h> File root; void setup() { Serial.begin(9600); pinMode(10, OUTPUT); SD.begin(10); root = SD.open("/"); printDirectory(root, 0); Serial.println("done!"); } void loop() { // nothing happens after setup finishes. } void pri… text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:filepeek?rev=1482675304&do=diff SD : File class peek() Read a byte from the file without advancing to the next one. That is, successive calls to peek() will return the same value, as will the next call to read(). peek() inherits from the Stream utility class. Syntax file.peek() text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:fileposition?rev=1482675304&do=diff SD : File class position() Get the current position within the file (i.e. the location to which the next byte will be read from or written to). Syntax file.position() Parameters file: an instance of the File class (returned by SD.open()) Returns text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:fileprint?rev=1482675304&do=diff SD : File class print() Description Print data to the file, which must have been opened for writing. Prints numbers as a sequence of digits, each an ASCII character (e.g. the number 123 is sent as the three characters '1', '2', '3'). Syntax file.print(data) text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:fileprintln?rev=1482675304&do=diff SD : File class println() Description Print data, followed by a carriage return and newline, to the File, which must have been opened for writing. Prints numbers as a sequence of digits, each an ASCII character (e.g. the number 123 is sent as the three characters '1', '2', '3'). text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:fileread?rev=1482675304&do=diff SD : File class read() Read a byte from the file. read() inherits from the Stream utility class. Syntax file.read() Parameters file: an instance of the File class (returned by SD.open()) Returns The next byte (or character), or -1 if none is available. text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:filerewinddirectory?rev=1482675304&do=diff SD : File class rewindDirectory() rewindDirectory() will bring you back to the first file in the directory, used in conjunction with openNextFile(). Syntax file.rewindDirectory() Parameters file: an instance of the File class. Returns None #include <SD.h> File root; void setup() { Serial.begin(9600); pinMode(10, OUTPUT); SD.begin(10); root = SD.open("/"); printDirectory(root, 0); Serial.println("done!"); } void loop() { // nothing happens after setup finishes. } v… text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:fileseek?rev=1482675304&do=diff SD : File class seek() Seek to a new position in the file, which must be between 0 and the size of the file (inclusive). Syntax file.seek(pos) Parameters file: an instance of the File class (returned by SD.open()) pos: the position to which to seek (unsigned long) text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:filesize?rev=1482675304&do=diff SD : File class size() Get the size of the file. Syntax file.size() Parameters file: an instance of the File class (returned by SD.open()) Returns the size of the file in bytes (unsigned long) Reference Home text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:filewrite?rev=1482675304&do=diff SD : File class write() Description Write data to the file. Syntax file.write(data) file.write(buf, len) Parameters file: an instance of the File class (returned by SD.open()) data: the byte, char, or string (char *) to write buf: an array of characters or bytes text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:irremote?rev=1482675304&do=diff IRremote Library This IR remote library lets you both send and receive IR remote codes in multiple protocols. It supports NEC, Sony SIRC, Philips RC5, Philips RC6, and raw protocols. If you want additional protocols, they are straightforward to add. The library can even be used to record codes from your remote and re-transmit them, as a minimal universal remote.It consists of two parts: IRsend transmits IR remote packets, while IRrecv receives and decodes an IR message. text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:liquidcrystal?rev=1482675304&do=diff LiquidCrystal Library This library allows an Arduino board to control LiquidCrystal displays (LCDs) based on the Hitachi HD44780 (or a compatible) chipset, which is found on most text-based LCDs. The library works with in either 4- or 8-bit mode (i.e. using 4 or 8 data lines in addition to the rs, enable, and, optionally, the rw control lines). text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:liquidcrystalautoscroll?rev=1482675304&do=diff LiquidCrystal autoscroll() Description Turns on automatic scrolling of the LCD. This causes each character output to the display to push previous characters over by one space. If the current text direction is left-to-right (the default), the display scrolls to the left; if the current direction is right-to-left, the display scrolls to the right. This has the effect of outputting each new character to the same location on the LCD. text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:liquidcrystalbegin?rev=1482675304&do=diff LiquidCrystal begin() Description Specifies the dimensions (width and height) of the display. Syntax lcd.begin(cols, rows) Parameters lcd: a variable of type LiquidCrystal cols: the number of columns that the display has rows: the number of rows that the display has text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:liquidcrystalblink?rev=1482675304&do=diff LiquidCrystal blink() Description Display the blinking LCD cursor. If used in combination with the cursor() function, the result will depend on the particular display. Syntax lcd.blink() Parameters lcd: a variable of type LiquidCrystal Example blink() and noBlink() text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:liquidcrystalclear?rev=1482675304&do=diff LiquidCrystal clear() Description Clears the LCD screen and positions the cursor in the upper-left corner. Syntax lcd.clear() Parameters lcd: a variable of type LiquidCrystal Reference Home text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:liquidcrystalconstructor?rev=1482675304&do=diff LiquidCrystal LiquidCrystal() Description Creates a variable of type LiquidCrystal. The display can be controlled using 4 or 8 data lines. If the former, omit the pin numbers for d0 to d3 and leave those lines unconnected. The RW pin can be tied to ground instead of connected to a pin on the Arduino; if so, omit it from this function's parameters. text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:liquidcrystalcreatechar?rev=1482675304&do=diff LiquidCrystal createChar() Description Create a custom character (gylph) for use on the LCD. Up to eight characters of 5×8 pixels are supported (numbered 0 to 7). The appearance of each custom character is specified by an array of eight bytes, one for each row. The five least significant bits of each byte determine the pixels in that row. To display a custom character on the screen, write() its number. text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:liquidcrystalcursor?rev=1482675304&do=diff LiquidCrystal cursor() Description Display the LCD cursor: an underscore (line) at the position to which the next character will be written. Syntax lcd.cursor() Parameters lcd: a variable of type LiquidCrystal Example cursor() and noCursor() See also noCursor() text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:liquidcrystaldisplay?rev=1482675304&do=diff LiquidCrystal display() Description Turns on the LCD display, after it's been turned off with noDisplay(). This will restore the text (and cursor) that was on the display. Syntax lcd.display() Parameters lcd: a variable of type LiquidCrystal Example display() and noDisplay() text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:liquidcrystalhome?rev=1482675304&do=diff LiquidCrystal home() Description Positions the cursor in the upper-left of the LCD. That is, use that location in outputting subsequent text to the display. To also clear the display, use the clear() function instead. Syntax lcd.home() Parameters lcd: a variable of type LiquidCrystal text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:liquidcrystallefttoright?rev=1482675304&do=diff LiquidCrystal leftToRight() Description Set the direction for text written to the LCD to left-to-right, the default. This means that subsequent characters written to the display will go from left to right, but does not affect previously-output text. Syntax lcd.leftToRight() text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:liquidcrystalnoautoscroll?rev=1482675304&do=diff LiquidCrystal noAutoscroll() Description Turns off automatic scrolling of the LCD. Syntax lcd.noAutoscroll() Parameters lcd: a variable of type LiquidCrystal See also autoscroll() Reference Home text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:liquidcrystalnoblink?rev=1482675304&do=diff LiquidCrystal noBlink() Description Turns off the blinking LCD cursor. Syntax lcd.noBlink() Parameters lcd: a variable of type LiquidCrystal Example blink() and noBlink() See also blink() Reference Home text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:liquidcrystalnocursor?rev=1482675304&do=diff LiquidCrystal noCursor() Description Hides the LCD cursor. Syntax lcd.noCursor() Parameters lcd: a variable of type LiquidCrystal Example cursor() and noCursor() See also cursor() Reference Home text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:liquidcrystalnodisplay?rev=1482675304&do=diff LiquidCrystal noDisplay() Description Turns off the LCD display, without losing the text currently shown on it. Syntax lcd.noDisplay() Parameters lcd: a variable of type LiquidCrystal Example display() and noDisplay() See also display() Reference Home text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:liquidcrystalprint?rev=1482675304&do=diff LiquidCrystal print() Description Prints text to the LCD. Syntax lcd.print(data) lcd.print(data, BASE) Parameters lcd: a variable of type LiquidCrystal data: the data to print (char, byte, int, long, or string) BASE (optional): the base in which to print numbers: BIN for binary (base 2), DEC for decimal (base 10), OCT for octal (base 8), HEX for hexadecimal (base 16). text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:liquidcrystalrighttoleft?rev=1482675304&do=diff LiquidCrystal rightToLeft() Description Set the direction for text written to the LCD to right-to-left (the default is left-to-right). This means that subsequent characters written to the display will go from right to left, but does not affect previously-output text. text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:liquidcrystalscrolldisplayleft?rev=1482675304&do=diff LiquidCrystal scrollDisplayLeft() Description Scrolls the contents of the display (text and cursor) one space to the left. Syntax lcd.scrollDisplayLeft() Parameters lcd: a variable of type LiquidCrystal Example scrollDisplayLeft() and scrollDisplayRight() text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:liquidcrystalscrolldisplayright?rev=1482675304&do=diff LiquidCrystal scrollDisplayRight() Description Scrolls the contents of the display (text and cursor) one space to the right. Syntax lcd.scrollDisplayRight() Parameters lcd: a variable of type LiquidCrystal Example scrollDisplayLeft() and scrollDisplayRight() text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:liquidcrystalsetcursor?rev=1482675304&do=diff LiquidCrystal setCursor() Description Position the LCD cursor; that is, set the location at which subsequent text written to the LCD will be displayed. Syntax lcd.setCursor(col, row) Parameters lcd: a variable of type LiquidCrystal col: the column at which to position the cursor (with 0 being the first column) text/html 2016-12-25T22:15:04+08:00 https://wiki.nxez.com/en:arduino:libraries:liquidcrystalwrite?rev=1482675304&do=diff LiquidCrystal write() Description Write a character to the LCD. Syntax lcd.write(data) Parameters lcd: a variable of type LiquidCrystal data: the character to write to the display Returns byte write() will return the number of bytes written, though reading that number is optional text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:sd?rev=1482675306&do=diff SD Library The SD library allows for reading from and writing to SD cards, e.g. on the Arduino Ethernet Shield. It is built on sdfatlib by William Greiman. The library supports FAT16 and FAT32 file systems on standard SD cards and SDHC cards. It uses short 8.3 names for files. The file names passed to the SD library functions can include paths separated by forward-slashes, /, e.g. text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:sdbegin?rev=1482675306&do=diff SD begin() Description Initializes the SD library and card. This begins use of the SPI bus (digital pins 11, 12, and 13 on most Arduino boards; 50, 51, and 52 on the Mega) and the chip select pin, which defaults to the hardware SS pin (pin 10 on most Arduino boards, 53 on the Mega). Note that even if you use a different chip select pin, the hardware SS pin must be kept as an output or the SD library functions will not work. text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:sdexists?rev=1482675306&do=diff SD exists() Description Tests whether a file or directory exists on the SD card. Syntax SD.exists(filename) Parameters filename: the name of the file to test for existence, which can include directories (delimited by forward-slashes, /) Returns text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:sdmkdir?rev=1482675306&do=diff SD mkdir() Description Create a directory on the SD card. This will also create any intermediate directories that don't already exists; e.g. SD.mkdir(“a/b/c”) will create a, b, and c. Syntax SD.mkdir(filename) Parameters filename: the name of the directory to create, with sub-directories separated by forward-slashes, / text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:sdopen?rev=1482675306&do=diff SD open() Description Opens a file on the SD card. If the file is opened for writing, it will be created if it doesn't already exist (but the directory containing it must already exist). Syntax SD.open(filepath) SD.open(filepath, mode) Parameters text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:sdremove?rev=1482675306&do=diff SD remove() Description Remove a file from the SD card. Syntax SD.remove(filename) Parameters filename: the name of the file to remove, which can include directories (delimited by forward-slashes, /) Returns true if the removal of the file succeeded, false if not. (if the file didn't exist, the return value is unspecified) text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:sdrmdir?rev=1482675306&do=diff SD rmdir() Description Remove a directory from the SD card. The directory must be empty. Syntax SD.rmdir(filename) Parameters filename: the name of the directory to remove, with sub-directories separated by forward-slashes, / Returns true if the removal of the directory succeeded, false if not. (if the directory didn't exist, the return value is unspecified) text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:serveravailable?rev=1482675306&do=diff Ethernet : Server class available() Description Gets a client that is connected to the server and has data available for reading. The connection persists when the returned client object goes out of scope; you can close it by calling client.stop(). available() inherits from the Stream utility class. text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:serverbegin?rev=1482675306&do=diff Ethernet : Server class begin() Description Tells the server to begin listening for incoming connections. Syntax server.begin() Parameters None Returns None Example #include <SPI.h> #include <Ethernet.h> // the media access control (ethernet hardware) address for the shield: byte mac[] = { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED }; //the IP address for the shield: byte ip[] = { 10, 0, 0, 177 }; // the router's gateway address: byte gateway[] = { 10, 0, 0, 1 }; // the subnet: byte s… text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:serverprint?rev=1482675306&do=diff Ethernet : Server class print() Description Print data to all the clients connected to a server. Prints numbers as a sequence of digits, each an ASCII character (e.g. the number 123 is sent as the three characters '1', '2', '3'). Syntax server.print(data) server.print(data, BASE) text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:serverprintln?rev=1482675306&do=diff Ethernet : Server class println() Description Print data, followed by a newline, to all the clients connected to a server. Prints numbers as a sequence of digits, each an ASCII character (e.g. the number 123 is sent as the three characters '1', '2', '3'). text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:serverwrite?rev=1482675306&do=diff Ethernet : Server class write() Description Write data to all the clients connected to a server. Syntax server.write(data) Parameters data: the value to write (byte or char) Returns byte write() returns the number of bytes written. It is not necessary to read this. text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:servo?rev=1482675306&do=diff Servo library This library allows an Arduino board to control RC (hobby) servo motors. Servos have integrated gears and a shaft that can be precisely controlled. Standard servos allow the shaft to be positioned at various angles, usually between 0 and 180 degrees. Continuous rotation servos allow the rotation of the shaft to be set to various speeds. text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:servoattach?rev=1482675306&do=diff Servo attach() Description Attach the Servo variable to a pin. Note that in Arduino 0016 and earlier, the Servo library supports only servos on only two pins: 9 and 10. Syntax servo.attach(pin) servo.attach(pin, min, max) Parameters servo: a variable of type Servo text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:servoattached?rev=1482675306&do=diff Servo attached() Description Check whether the Servo variable is attached to a pin. Syntax servo.attached() Parameters servo: a variable of type Servo Returns true if the servo is attached to pin; false otherwise. See also * attach() * detach() text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:servodetach?rev=1482675306&do=diff Servo detach() Description Detach the Servo variable from its pin. If all Servo variables are detached, then pins 9 and 10 can be used for PWM output with analogWrite(). Syntax servo.detach() Parameters servo: a variable of type Servo See also * text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:servoread?rev=1482675306&do=diff Servo read() Description Read the current angle of the servo (the value passed to the last call to write()). Syntax servo.read() Parameters servo: a variable of type Servo Returns The angle of the servo, from 0 to 180 degrees. See also * write() text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:servowrite?rev=1482675306&do=diff Servo write() Description Writes a value to the servo, controlling the shaft accordingly. On a standard servo, this will set the angle of the shaft (in degrees), moving the shaft to that orientation. On a continuous rotation servo, this will set the speed of the servo (with 0 being full-speed in one direction, 180 being full speed in the other, and a value near 90 being no movement). text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:servowritemicroseconds?rev=1482675306&do=diff Servo writeMicroseconds() Description Writes a value in microseconds (uS) to the servo, controlling the shaft accordingly. On a standard servo, this will set the angle of the shaft. On standard servos a parameter value of 1000 is fully counter-clockwise, 2000 is fully clockwise, and 1500 is in the middle. text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:softwareserial?rev=1482675306&do=diff SoftwareSerial Library The Arduino hardware has built-in support for serial communication on pins 0 and 1 (which also goes to the computer via the USB connection). The native serial support happens via a piece of hardware (built into the chip) called a UART. This hardware allows the Atmega chip to receive serial communication even while working on other tasks, as long as there room in the 64 byte serial buffer. text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:softwareserialavailable?rev=1482675306&do=diff SoftwareSerial: available() Description Get the number of bytes (characters) available for reading from a software serial port. This is data that's already arrived and stored in the serial receive buffer. Syntax mySerial.available() Parameters text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:softwareserialconstructor?rev=1482675306&do=diff SoftwareSerial(rxPin, txPin) Description A call to SoftwareSerial(rxPin, txPin) creates a new SoftwareSerial object, whose name you need to provide as in the example below. You need to call SoftwareSerial.begin() to enable communication. Parameters text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:spi?rev=1482675306&do=diff SPI library This library allows you to communicate with SPI devices, with the Arduino as the master device. A Brief Introduction to the Serial Peripheral Interface (SPI) Serial Peripheral Interface (SPI) is a synchronous serial data protocol used by microcontrollers for communicating with one or more peripheral devices quickly over short distances. It can also be used for communication between two microcontrollers. text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:spibegin?rev=1482675306&do=diff SPI begin() Description Initializes the SPI bus, setting SCK, MOSI, and SS to outputs, pulling SCK and MOSI low and SS high. Syntax SPI.begin() Parameters None Returns None See also end() Reference Home text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:spiend?rev=1482675306&do=diff SPI end() Description Disables the SPI bus (leaving pin modes unchanged). Syntax SPI.end() Parameters None Returns None See also * begin() Reference Home text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:spisetbitorder?rev=1482675306&do=diff SPI setBitOrder() Description Sets the order of the bits shifted out of and into the SPI bus, either LSBFIRST (least-significant bit first) or MSBFIRST (most-significant bit first). Syntax SPI.setBitOrder(order) Parameters order: either LSBFIRST or MSBFIRST text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:spisetclockdivider?rev=1482675306&do=diff SPI setClockDivider() Description Sets the SPI clock divider relative to the system clock. The dividers available are 2, 4, 8, 16, 32, 64, or 128. The default setting is SPI_CLOCK_DIV4, which sets the SPI clock to one-quarter the frequency of the system clock. text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:spisetdatamode?rev=1482675306&do=diff SPI setDataMode() Description Sets the SPI data mode: that is, clock polarity and phase. See the Wikipedia article on SPI for details. Syntax SPI.setDataMode(mode) Parameters mode: SPI_MODE0, SPI_MODE1, SPI_MODE2, or SPI_MODE3 Returns None See also text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:spitransfer?rev=1482675306&do=diff SPI transfer() Description Transfers one byte over the SPI bus, both sending and receiving. Syntax SPI.transfer(val) Parameters val: the byte to send out over the bus Returns the byte read from the bus Reference Home text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:stepper?rev=1482675306&do=diff Stepper Library This library allows you to control unipolar or bipolar stepper motors. To use it you will need a stepper motor, and the appropriate hardware to control it. For more on that, see Tom Igoe's notes on steppers. Circuits * Unipolar Steppers text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:stepperconstructor?rev=1482675306&do=diff Stepper(steps, pin1, pin2) Stepper(steps, pin1, pin2, pin3, pin4) Description This function creates a new instance of the Stepper class that represents a particular stepper motor attached to your Arduino board. Use it at the top of your sketch, above setup() and loop(). The number of parameters depends on how you've wired your motor - either using two or four pins of the Arduino board. text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:steppersetspeed?rev=1482675306&do=diff Stepper: setSpeed(rpms) Description Sets the motor speed in rotations per minute (RPMs). This function doesn't make the motor turn, just sets the speed at which it will when you call step(). Parameters rpms: the speed at which the motor should turn in rotations per minute - a positive number (long) text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:stepperstep?rev=1482675306&do=diff Stepper: step(steps) Description Turns the motor a specific number of steps, at a speed determined by the most recent call to setSpeed(). This function is blocking; that is, it will wait until the motor has finished moving to pass control to the next line in your sketch. For example, if you set the speed to, say, 1 RPM and called step(100) on a 100-step motor, this function would take a full minute to run. For better control, keep the speed high and only go a few steps with each call to step()… text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:wire?rev=1482675306&do=diff Wire Library This library allows you to communicate with I2C / TWI devices. On most Arduino boards, SDA (data line) is on analog input pin 4, and SCL (clock line) is on analog input pin 5. On the Arduino Mega, SDA is digital pin 20 and SCL is 21. As of Arduino 1.0, the library inherits from the Stream functions, making it consistent with other read/write libraries. Because of this, send() and receive() have been replaced with read() and write(). text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:wirebegin?rev=1482675306&do=diff Wire.begin() Wire.begin(address) Description Initiate the Wire library and join the I2C bus as a master or slave. This should normally be called only once. Parameters address: the 7-bit slave address (optional); if not specified, join the bus as a master. text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:wirebegintransmission?rev=1482675306&do=diff Wire.beginTransmission(address) Description Begin a transmission to the I2C slave device with the given address. Subsequently, queue bytes for transmission with the write() function and transmit them by calling endTransmission(). Parameters address: the 7-bit address of the device to transmit to text/html 2016-12-25T22:15:06+08:00 https://wiki.nxez.com/en:arduino:libraries:wirerequestfrom?rev=1482675306&do=diff Wire.requestFrom() Description Used by the master to request bytes from a slave device. The bytes may then be retrieved with the available() and read() functions. As of Arduino 1.0.1, requestFrom() accepts a boolean argument changing its behavior for compatibility with certain I2C devices.