fixup! docs(stdlib): add missing descriptions for xod-dev/w5500, xod/net and xod/stream

This commit is contained in:
Evgeny Kochetkov
2018-07-05 16:18:24 +03:00
parent 91a7bf669d
commit 8472b29eff
23 changed files with 105 additions and 106 deletions

View File

@@ -1,8 +1,8 @@
{
"description": "Closes TCP connection",
"description": "Closes an open TCP connection",
"nodes": [
{
"description": "Pulses when connection is closed",
"description": "Pulses when the connection is closed",
"id": "BJsYpQtZm",
"label": "DONE",
"position": {
@@ -12,7 +12,7 @@
"type": "xod/patch-nodes/output-pulse"
},
{
"description": "Close connection",
"description": "Close the connection",
"id": "SJldxXCv-m",
"label": "CLS",
"position": {
@@ -22,7 +22,7 @@
"type": "xod/patch-nodes/input-pulse"
},
{
"description": "Socket",
"description": "The socket",
"id": "rJ53A_vzQ",
"label": "SOCK",
"position": {

View File

@@ -1,8 +1,8 @@
{
"description": "Establish internet connection with manual configuration",
"description": "Establish an internet connection configured manually",
"nodes": [
{
"description": "Internet connection",
"description": "The internet connection",
"id": "B1UUEfYMX",
"label": "INET",
"position": {
@@ -20,7 +20,7 @@
"type": "xod/patch-nodes/not-implemented-in-xod"
},
{
"description": "Pulses on successful connection",
"description": "Pulses on a successful connection",
"id": "H1ZLMdSLWQ",
"label": "DONE",
"position": {
@@ -30,7 +30,7 @@
"type": "xod/patch-nodes/output-pulse"
},
{
"description": "IP address of the gateway. By default is the same as IP but with last octet being '1'",
"description": "An IP address of the gateway. Defaults to `IP` with the last octet being `1`",
"id": "HyVxSMFzQ",
"label": "GTW",
"position": {
@@ -43,7 +43,7 @@
"boundLiterals": {
"__out__": "On Boot"
},
"description": "Establish connection",
"description": "Establish the connection",
"id": "Syz8zur8WQ",
"label": "CONN",
"position": {
@@ -53,7 +53,7 @@
"type": "xod/patch-nodes/input-pulse"
},
{
"description": "Subnet mask. 255.255.255.0 by default",
"description": "A subnet mask. Defaults to `255.255.255.0`",
"id": "r1XbSzFz7",
"label": "SBN",
"position": {
@@ -63,7 +63,7 @@
"type": "xod/net/input-ip-address"
},
{
"description": "IP address of the DNS server. By default is the same as IP but with last octet being '1'",
"description": "An IP address of the DNS server. Defaults to `IP` with the last octet being `1`",
"id": "rkZSNzKz7",
"label": "DNS",
"position": {
@@ -73,7 +73,7 @@
"type": "xod/net/input-ip-address"
},
{
"description": "Pulses if connection failed",
"description": "Pulses if the connection failed",
"id": "rkgIz_SLW7",
"label": "ERR",
"position": {
@@ -93,7 +93,7 @@
"type": "xod/net/input-ip-address"
},
{
"description": "Device configuration",
"description": "A W5500-based internet provider device",
"id": "rygPuMYz7",
"label": "DEV",
"position": {

View File

@@ -1,5 +1,5 @@
{
"description": "Establish internet connection by automatically getting all required configuration info from a DHCP server",
"description": "Establish an internet connection by automatically getting all required configuration info from a DHCP server",
"nodes": [
{
"id": "BJXXLBwPfQ",
@@ -13,7 +13,7 @@
"boundLiterals": {
"__out__": "On Boot"
},
"description": "Establish connection",
"description": "Establish the connection",
"id": "BJfXLrPDzm",
"label": "CONN",
"position": {
@@ -23,7 +23,7 @@
"type": "xod/patch-nodes/input-pulse"
},
{
"description": "Pulses on successful connection",
"description": "Pulses on a successful connection",
"id": "H1b7LrDPGm",
"label": "DONE",
"position": {
@@ -33,7 +33,7 @@
"type": "xod/patch-nodes/output-pulse"
},
{
"description": "Device configuration",
"description": "A W5500-based internet provider device",
"id": "HkhKBPPfX",
"label": "DEV",
"position": {
@@ -43,7 +43,7 @@
"type": "@/input-ethernet-shield-device"
},
{
"description": "Internet connection",
"description": "An internet connection",
"id": "rJ6H7ovfQ",
"label": "INET",
"position": {
@@ -53,7 +53,7 @@
"type": "@/output-inet"
},
{
"description": "Pulses if connection failed",
"description": "Pulses if the connection failed",
"id": "ryx7LHwPfm",
"label": "ERR",
"position": {

View File

@@ -5,7 +5,7 @@
"boundLiterals": {
"__out__": "D10"
},
"description": "Chip select port",
"description": "The chip select port",
"id": "HyvDHC7G7",
"label": "CS",
"position": {
@@ -15,7 +15,7 @@
"type": "xod/patch-nodes/input-port"
},
{
"description": "Ethernet shield configuration",
"description": "A W5500-based internet provider device",
"id": "SJfNS0XfX",
"label": "DEV",
"position": {
@@ -33,7 +33,7 @@
"type": "xod/patch-nodes/not-implemented-in-xod"
},
{
"description": "MAC address of the shield",
"description": "The MAC address",
"id": "rkKSHAXMQ",
"label": "MAC",
"position": {

View File

@@ -1,5 +1,5 @@
{
"description": "Checks if there is incoming data to be read with `read-byte`",
"description": "Checks if there is any incoming data to be read with `read-byte`",
"nodes": [
{
"id": "B1Dse0wbm",
@@ -10,7 +10,7 @@
"type": "xod/patch-nodes/not-implemented-in-xod"
},
{
"description": "Socket",
"description": "The socket",
"id": "BkzF0dvfQ",
"label": "SOCK",
"position": {

View File

@@ -1,5 +1,5 @@
{
"description": "Performs an HTTP request and returns response as a stream of characters",
"description": "Performs an HTTP request and returns the response as a stream of characters",
"links": [
{
"id": "B1tS0uqfm",
@@ -258,7 +258,7 @@
"nodes": [
{
"boundLiterals": {
"HkcCKGYZ7": "\"/ip\""
"HkcCKGYZ7": "\"/\""
},
"id": "B1eIvL_wzQ",
"position": {
@@ -290,7 +290,7 @@
"boundLiterals": {
"__out__": "80"
},
"description": "TCP port number on which the server is listening",
"description": "The TCP port number on which the server is listening",
"id": "Byx8eOuwM7",
"label": "PORT",
"position": {
@@ -308,7 +308,7 @@
"type": "xod/core/any"
},
{
"description": "Pulses when new response character is received",
"description": "Pulses when a new response character is received",
"id": "H1eCETuwMQ",
"label": "RCV",
"position": {
@@ -341,7 +341,7 @@
"boundLiterals": {
"__out__": "\"\""
},
"description": "Request body(optional)",
"description": "The request body(optional)",
"id": "HyQqRPuDzm",
"label": "BODY",
"position": {
@@ -351,7 +351,7 @@
"type": "xod/patch-nodes/input-string"
},
{
"description": "Last received character from the response",
"description": "The last received character from the response",
"id": "S1RETdDM7",
"label": "CHAR",
"position": {
@@ -364,7 +364,7 @@
"boundLiterals": {
"__out__": "\"/\""
},
"description": "Path to requested resource",
"description": "The path to the requested resource",
"id": "S1x50vdwz7",
"label": "PATH",
"position": {
@@ -408,7 +408,7 @@
"type": "@/send"
},
{
"description": "Pulses when all response data is received and connection is closed",
"description": "Pulses when all response data is received and the connection is closed",
"id": "r1ZRN6uvMQ",
"label": "DONE",
"position": {
@@ -418,7 +418,7 @@
"type": "xod/patch-nodes/output-pulse"
},
{
"description": "Pulses if request failed",
"description": "Pulses if the request failed",
"id": "rJMAEpOvGX",
"label": "ERR",
"position": {
@@ -428,7 +428,7 @@
"type": "xod/patch-nodes/output-pulse"
},
{
"description": "Internet connection",
"description": "The internet connection",
"id": "rJsfmiDfQ",
"label": "INET",
"position": {
@@ -438,7 +438,7 @@
"type": "@/input-inet"
},
{
"description": "Begin request",
"description": "Begin the request",
"id": "rkIxO_wfm",
"label": "INIT",
"position": {
@@ -451,7 +451,7 @@
"boundLiterals": {
"__out__": "\"GET\""
},
"description": "HTTP method (e.g., GET, POST, PUT, or DELETE)",
"description": "The HTTP method (e.g., GET, POST, PUT, or DELETE)",
"id": "ryG9Av_PfQ",
"label": "METH",
"position": {

View File

@@ -1,8 +1,8 @@
{
"description": "Checks if TCP connection is open",
"description": "Checks if a TCP connection is open",
"nodes": [
{
"description": "Pulses if connection is open",
"description": "Pulses if the connection is open",
"id": "BJQB3m4tZ7",
"label": "Y",
"position": {
@@ -12,7 +12,7 @@
"type": "xod/patch-nodes/output-pulse"
},
{
"description": "Pulses if connection is closed",
"description": "Pulses if the connection is closed",
"id": "BJzB2QNFbQ",
"label": "N",
"position": {
@@ -22,7 +22,7 @@
"type": "xod/patch-nodes/output-pulse"
},
{
"description": "Socket",
"description": "The socket",
"id": "Hke2RdvMm",
"label": "SOCK",
"position": {

View File

@@ -1,5 +1,5 @@
{
"description": "Gets local IP address",
"description": "Gets the local IP address",
"nodes": [
{
"description": "Internet connection",
@@ -12,7 +12,7 @@
"type": "@/input-inet"
},
{
"description": "IP address",
"description": "The IP address",
"id": "r15ySjwzQ",
"label": "IP",
"position": {
@@ -22,7 +22,6 @@
"type": "xod/net/output-ip-address"
},
{
"description": "Gets local IP",
"id": "rkNlrjDfm",
"position": {
"x": 34,

View File

@@ -1,8 +1,8 @@
{
"description": "Open TCP connection to specified server",
"description": "Open a TCP connection to the specified server",
"nodes": [
{
"description": "Pulses when connection is successfully open",
"description": "Pulses when the connection is successfully open",
"id": "BJo1fvrZQ",
"label": "DONE",
"position": {
@@ -12,7 +12,7 @@
"type": "xod/patch-nodes/output-pulse"
},
{
"description": "Socket",
"description": "The socket",
"id": "BJrKIOvzQ",
"label": "SOCK",
"position": {
@@ -22,7 +22,7 @@
"type": "xod/net/output-socket"
},
{
"description": "Open connection",
"description": "Open the connection",
"id": "Byx-7vSZX",
"label": "CONN",
"position": {
@@ -32,7 +32,7 @@
"type": "xod/patch-nodes/input-pulse"
},
{
"description": "Internet connection",
"description": "The internet connection",
"id": "HyEmmowMm",
"label": "INET",
"position": {
@@ -76,7 +76,7 @@
"boundLiterals": {
"__out__": "80"
},
"description": "Port number",
"description": "The port number",
"id": "r1Oj-DrWX",
"label": "PORT",
"position": {

View File

@@ -1,8 +1,8 @@
{
"description": "Read a single byte of response from opened connection",
"description": "Read a single byte of the response from the opened connection",
"nodes": [
{
"description": "Read byte",
"description": "Read the byte",
"id": "H1PYmAwb7",
"label": "READ",
"position": {
@@ -12,7 +12,7 @@
"type": "xod/patch-nodes/input-pulse"
},
{
"description": "Socket",
"description": "The socket",
"id": "HJSh0OPfQ",
"label": "SOCK",
"position": {
@@ -30,7 +30,7 @@
"type": "xod/patch-nodes/not-implemented-in-xod"
},
{
"description": "Last read byte",
"description": "The last read byte",
"id": "HyOdm0D-Q",
"label": "B",
"position": {
@@ -40,7 +40,7 @@
"type": "xod/patch-nodes/output-byte"
},
{
"description": "Pulses when byte is read",
"description": "Pulses when the byte is read",
"id": "rkEq7RDWQ",
"label": "DONE",
"position": {

View File

@@ -1,5 +1,5 @@
{
"description": "Read response from opened connection as a stream of bytes until it closes",
"description": "Read a response from the opened connection as a stream of bytes until it closes",
"links": [
{
"id": "B1LlEQpuwzX",
@@ -180,7 +180,7 @@
],
"nodes": [
{
"description": "Last byte read",
"description": "The last read byte",
"id": "B1gVQTOwfQ",
"position": {
"x": 102,
@@ -247,7 +247,7 @@
"type": "@/has-available-byte"
},
{
"description": "Pulses when new byte is read",
"description": "Pulses when a new byte is read",
"id": "SyZVX6_Df7",
"position": {
"x": 136,
@@ -264,7 +264,7 @@
"type": "xod/core/any"
},
{
"description": "Socket",
"description": "The socket",
"id": "rJyDi_wGQ",
"label": "SOCK",
"position": {
@@ -274,7 +274,7 @@
"type": "xod/net/input-socket"
},
{
"description": "Pulses when connection is closed",
"description": "Pulses when the connection is closed",
"id": "ryU4XT_PMX",
"label": "CLS",
"position": {

View File

@@ -1,8 +1,8 @@
{
"description": "Send message through opened TCP connection",
"description": "Send a message through the opened TCP connection",
"nodes": [
{
"description": "Pulses when sending failed (for example, connection is not open)",
"description": "Pulses when sending failed (for example, the connection is not open)",
"id": "ByzTg3LZX",
"label": "ERR",
"position": {
@@ -20,7 +20,7 @@
"type": "xod/patch-nodes/not-implemented-in-xod"
},
{
"description": "Message to send",
"description": "The message to send",
"id": "Sk8_R9L-X",
"label": "MSG",
"position": {
@@ -30,7 +30,7 @@
"type": "xod/patch-nodes/input-string"
},
{
"description": "Send message",
"description": "Send the message",
"id": "SkLcRqIZm",
"label": "SND",
"position": {
@@ -40,7 +40,7 @@
"type": "xod/patch-nodes/input-pulse"
},
{
"description": "Pulses when message is successfully sent",
"description": "Pulses when the message is successfully sent",
"id": "r1NYAqIZ7",
"label": "DONE",
"position": {
@@ -50,7 +50,7 @@
"type": "xod/patch-nodes/output-pulse"
},
{
"description": "Socket",
"description": "The socket",
"id": "ryg9suwMX",
"label": "SOCK",
"position": {

View File

@@ -279,7 +279,7 @@
"type": "xod/core/format-number"
},
{
"description": "HTTP request message",
"description": "The HTTP request message",
"id": "H1leYGFbm",
"position": {
"x": 0,
@@ -299,7 +299,7 @@
"boundLiterals": {
"__out__": "\"/\""
},
"description": "Path to requested resource",
"description": "A path to the requested resource",
"id": "HkcCKGYZ7",
"label": "PATH",
"position": {
@@ -336,7 +336,7 @@
"boundLiterals": {
"__out__": "\"GET\""
},
"description": "HTTP method (e.g., GET, POST, PUT, or DELETE)",
"description": "The HTTP method (e.g., GET, POST, PUT, or DELETE)",
"id": "SkQFtMKZm",
"label": "METH",
"position": {
@@ -360,7 +360,7 @@
"boundLiterals": {
"__out__": "\"\""
},
"description": "Request body(optional)",
"description": "The request body(optional)",
"id": "Sy5v9zFZ7",
"label": "BODY",
"position": {
@@ -370,7 +370,7 @@
"type": "xod/patch-nodes/input-string"
},
{
"description": "Whether connection should be kept alive",
"description": "Whether a connection should be kept alive",
"id": "rJiucMFW7",
"label": "KA",
"position": {

View File

@@ -1,5 +1,5 @@
{
"description": "Converts IP address to string",
"description": "Converts an IP address to string",
"links": [
{
"id": "BJHQpQWbX",
@@ -178,7 +178,7 @@
"type": "xod/core/join"
},
{
"description": "IP address as string",
"description": "The IP address as string",
"id": "By1xaQb-m",
"position": {
"x": 68,
@@ -187,7 +187,7 @@
"type": "xod/patch-nodes/output-string"
},
{
"description": "IP address",
"description": "The IP address",
"id": "H17mp7ZZX",
"position": {
"x": 102,

View File

@@ -37,7 +37,7 @@
"type": "xod/patch-nodes/not-implemented-in-xod"
},
{
"description": "IP address",
"description": "The IP address",
"id": "rk1-AWlbm",
"position": {
"x": 34,

View File

@@ -70,7 +70,7 @@
"type": "xod/patch-nodes/input-byte"
},
{
"description": "MAC address",
"description": "The MAC address",
"id": "SJqcJZSW7",
"position": {
"x": 0,

View File

@@ -1,8 +1,8 @@
{
"description": "Creates a string from a stream of characters by appending each new character to the end of the string until maximum capacity is reached.",
"description": "Create a string from a stream of characters by appending each new character to the end of the string until a maximum capacity is reached.",
"nodes": [
{
"description": "New character to be pushed at the end of the string",
"description": "The new character to be pushed at the end of the string",
"id": "HJi_30PZX",
"label": "CHAR",
"position": {
@@ -15,7 +15,7 @@
"boundLiterals": {
"__out__": "16"
},
"description": "Capacity of the string buffer. Defines the maximum length. Must be a constant value. Any changes during program execution will be ignored.",
"description": "The capacity of the string buffer. Defines the maximum length. Must be a constant value. Any changes during program execution will be ignored.",
"id": "HkAv2Av-X",
"label": "CAP",
"position": {

View File

@@ -20,7 +20,7 @@
"type": "xod/patch-nodes/not-implemented-in-xod"
},
{
"description": "Resulting integer",
"description": "The resulting integer",
"id": "Sk6oKXA-Q",
"label": "NUM",
"position": {
@@ -40,7 +40,7 @@
"type": "xod/patch-nodes/input-pulse"
},
{
"description": "Reset parsed number to 0 and start over",
"description": "Reset the parsed number to 0 and start over",
"id": "r1JWmAxzQ",
"label": "RST",
"position": {
@@ -50,7 +50,7 @@
"type": "xod/patch-nodes/input-pulse"
},
{
"description": "Next character to be procesed",
"description": "The next character to be processed",
"id": "rJ55KmC-X",
"label": "CHAR",
"position": {

View File

@@ -1,5 +1,5 @@
{
"description": "Lets characters pass through only after specified sequence is encountered",
"description": "Lets the characters pass through only after a specified sequence is encountered",
"links": [
{
"id": "BJ6bvoR-7",
@@ -125,7 +125,7 @@
],
"nodes": [
{
"description": "Character to be pushed through",
"description": "A character to be pushed through",
"id": "B18iIoA-m",
"position": {
"x": -1,
@@ -134,7 +134,7 @@
"type": "xod/patch-nodes/input-byte"
},
{
"description": "Stop passing characters through until next SEQ",
"description": "Stop passing the characters through until next SEQ",
"id": "BJhHwoRb7",
"label": "RST",
"position": {
@@ -171,7 +171,7 @@
"type": "xod/core/flip-flop"
},
{
"description": "Character that passed through",
"description": "A character that passed through",
"id": "SkSGwoAZQ",
"position": {
"x": 0,
@@ -197,7 +197,7 @@
"type": "@/pass-if"
},
{
"description": "Searched sequence",
"description": "The searched sequence",
"id": "rkZ8oIj0-m",
"label": "SEQ",
"position": {
@@ -207,7 +207,7 @@
"type": "xod/patch-nodes/input-string"
},
{
"description": "Try to push new character through",
"description": "Try to push a new character through",
"id": "rklUo8jA-Q",
"position": {
"x": 34,

View File

@@ -1,5 +1,5 @@
{
"description": "Lets values pass through only if COND is true",
"description": "Let the values pass through only if COND is true",
"nodes": [
{
"id": "B1dMI7RWX",
@@ -10,7 +10,7 @@
"type": "xod/patch-nodes/not-implemented-in-xod"
},
{
"description": "Value that passed through",
"description": "A value that passed through",
"id": "HyqbI70-7",
"position": {
"x": 0,
@@ -19,7 +19,7 @@
"type": "xod/patch-nodes/output-t1"
},
{
"description": "Value to be pushed through",
"description": "A value to be pushed through",
"id": "S1618X0bX",
"position": {
"x": 0,
@@ -37,7 +37,7 @@
"type": "xod/patch-nodes/output-pulse"
},
{
"description": "Decides whether values should be let through",
"description": "Decides whether the values should be let through",
"id": "SyN0S7RZ7",
"label": "COND",
"position": {
@@ -47,7 +47,7 @@
"type": "xod/patch-nodes/input-boolean"
},
{
"description": "Try to push new value through",
"description": "Try to push a new value through",
"id": "rJ5aSXCWm",
"position": {
"x": 102,

View File

@@ -1,5 +1,5 @@
{
"description": "Lets values pass through until value specified in S is encountered",
"description": "Let the values pass through until the value specified in S is encountered",
"links": [
{
"id": "B1b8djCWm",
@@ -114,7 +114,7 @@
],
"nodes": [
{
"description": "Value to be pushed through",
"description": "A value to be pushed through",
"id": "BJYbP7CZm",
"position": {
"x": 102,
@@ -142,7 +142,7 @@
"type": "xod/core/flip-flop"
},
{
"description": "Value that passed through",
"description": "A value that passed through",
"id": "By5Vv7C-7",
"position": {
"x": 34,
@@ -162,7 +162,7 @@
"boundLiterals": {
"__out__": "On Boot"
},
"description": "Start letting values through until another S",
"description": "Start letting the values through until another S",
"id": "S1a8PX0Wm",
"label": "RST",
"position": {
@@ -190,7 +190,7 @@
"type": "xod/core/pulse-on-true"
},
{
"description": "Try to push new value through",
"description": "Try to push a new value through",
"id": "r1CWwm0b7",
"position": {
"x": 204,

View File

@@ -2,7 +2,7 @@
"description": "Pulses each time when a specified sequence of characters is encountered",
"nodes": [
{
"description": "Push next character",
"description": "Push the next character",
"id": "B14qE5RZ7",
"position": {
"x": 136,
@@ -20,7 +20,7 @@
"type": "xod/patch-nodes/output-pulse"
},
{
"description": "Next character in a stream",
"description": "The next character in a stream",
"id": "HkAtN5CbX",
"position": {
"x": 34,
@@ -29,7 +29,7 @@
"type": "xod/patch-nodes/input-byte"
},
{
"description": "Searched sequence",
"description": "The searched sequence",
"id": "Hy9qN5AZm",
"label": "SEQ",
"position": {

View File

@@ -1,5 +1,5 @@
{
"description": "Lets values pass through only after value specified in S is encountered",
"description": "Let the values pass through only after the value specified in S is encountered",
"links": [
{
"id": "ByFqJd70b7",
@@ -133,7 +133,7 @@
"type": "xod/core/defer"
},
{
"description": "Stops letting values through until another S",
"description": "Stops letting the values through until another S",
"id": "B1S9JuXRbX",
"label": "RST",
"position": {
@@ -143,7 +143,7 @@
"type": "xod/patch-nodes/input-pulse"
},
{
"description": "Values after this one will be passed through",
"description": "All values after this one will be passed through",
"id": "BJ-qyu70ZX",
"label": "S",
"position": {
@@ -170,7 +170,7 @@
"type": "@/pass-if"
},
{
"description": "Try to push new value through",
"description": "Try to push a new value through",
"id": "HJec1dQCZ7",
"position": {
"x": 170,
@@ -198,7 +198,7 @@
"type": "xod/core/flip-flop"
},
{
"description": "Value to be pushed through",
"description": "A value to be pushed through",
"id": "Skc1_Q0-X",
"position": {
"x": 68,
@@ -207,7 +207,7 @@
"type": "xod/patch-nodes/input-t1"
},
{
"description": "Value that passed through",
"description": "A value that passed through",
"id": "r1M51O7Rbm",
"position": {
"x": 0,