add multiFilter to the api doc

sandeepmistry · May 31, 2019 · c47b9ee · c47b9ee
1 parent 56df49c
commit c47b9ee
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/API.md b/API.md
@@ -247,6 +247,18 @@ if ((packetId & mask) == id) {
 
 Returns `1` on success, `0` on failure.
 
+### Advanced Filtering
+
+```
+CAN.multiFilter(ids, count);
+```
+
+ * `ids` - array of 11-bit ids
+ * `count` - count of entries in `ids`
+
+Only packets with an id in `ids` are acknowleged and received, other packets are ignored.
+If `count` is larger than the filters supported by your CAN hardware additional frame ids might be received.
+
 ## Other modes
 
 ### Loopback mode