summaryrefslogtreecommitdiff
path: root/peripheral/libmraa/src/javascript/doxygen2jsdoc_custom.json
blob: c5095e0558c30cb23b0fb613c1aac7712494f3ce (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
{
  "Uart": {
    "read": {
      "description": "Read length bytes from the device",
      "params": {
        "length": {
          "type": "Number",
          "description": "Size of read in bytes to make"
        }
      },
      "return": {
        "type": "Buffer",
        "description": "Data read"
      }
    },
    "write": {
      "description": "Write length bytes to the device",
      "params": {
        "length": {
          "type": "Number",
          "description": "Size of buffer to send"
        }
      },
      "return": {
        "type": "mraa_result_t",
        "description": "Result of operation"
      }
    }
  },
  "I2c": {
    "read": {
      "description": "Read length bytes from the bus",
      "params": {
        "length": {
          "type": "Number",
          "description": "Size of read in bytes to make"
        }
      },
      "return": {
        "type": "Buffer",
        "description": "Data read"
      }
    },
    "write": {
      "description": "Write length bytes to the bus, the first byte in the Buffer is the command/register to write",
      "params": {
        "length": {
          "type": "Number",
          "description": "Size of buffer to send"
        }
      },
      "return": {
        "type": "mraa_result_t",
        "description": "Result of operation"
      }
    }
  },
  "Gpio": {
    "isr": {
      "description": "Sets a callback to be called when pin value changes",
      "params": {
        "mode": {
          "type": "Edge",
          "description": "The edge mode to set"
        },
        "func": {
          "type": "Function",
          "description": "Function to be called when interrupt is triggered"
        }
      },
      "return": {
        "type": "mraa_result_t",
        "description": "Result of operation"
      }
    }
  }
}