Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var IndexPayload = Type("arduino.index", func() {
TypeName("IndexPayload")
Attribute("url", String, "The url of the index file", func() {
Example("http://downloads.arduino.cc/packages/package_index.json")
})
Required("url")
})
View Source
var Operation = ResultType("application/vnd.arduino.operation", func() {
Description("Describes the result of an operation.")
TypeName("Operation")
Attribute("status", String, "The status of the operation", func() {
Example("ok")
})
Required("status")
})
View Source
var Tool = ResultType("application/vnd.arduino.tool", func() { Description("A tool is an executable program that can upload sketches.") TypeName("Tool") Reference(ToolPayload) Attribute("name") Attribute("version") Attribute("packager") Required("name", "version", "packager") })
View Source
var ToolPayload = Type("arduino.tool", func() {
Description(`A tool is an executable program that can upload sketches.
If url is absent the tool will be searched among the package index installed`)
TypeName("ToolPayload")
Attribute("name", String, "The name of the tool", func() {
Example("avrdude")
})
Attribute("version", String, "The version of the tool", func() {
Example("6.3.0-arduino9")
})
Attribute("packager", String, "The packager of the tool", func() {
Example("arduino")
})
Attribute("url", String, `The url where the package can be found. Optional.
If present checksum must also be present.`)
Attribute("checksum", String, `A checksum of the archive. Mandatory when url is present.
This ensures that the package is downloaded correcly.`)
Required("name", "version", "packager")
})
Functions ¶
This section is empty.
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.