mirror of
https://github.com/xodio/xod.git
synced 2026-03-14 12:46:54 +01:00
89 lines
2.8 KiB
Markdown
89 lines
2.8 KiB
Markdown
---
|
||
title: XOD Documentation
|
||
---
|
||
|
||
XOD Documentation
|
||
=================
|
||
|
||
Tutorials
|
||
---------
|
||
|
||
* [Installing and running XOD](./tutorial/install/)
|
||
* [Required hardware](./tutorial/required-hardware/)
|
||
|
||
1. [Hello](./tutorial/01-hello/)
|
||
2. [Upload to Arduino](./tutorial/02-deploy/)
|
||
3. [Pins, data, and the Inspector](./tutorial/03-inspector/)
|
||
4. [Fractional numbers and PWM](./tutorial/04-pwm/)
|
||
5. [Wiring configuration](./tutorial/05-wiring/)
|
||
6. [Adding nodes](./tutorial/06-adding-nodes/)
|
||
7. [Node labels](./tutorial/07-labels/)
|
||
8. [Constant nodes](./tutorial/08-constants/)
|
||
9. [Input from a potentiometer](./tutorial/09-pot/)
|
||
10. [Doing math](./tutorial/10-math/)
|
||
11. [Controlling servos](./tutorial/11-servo/)
|
||
12. [Accessing help](./tutorial/12-help/)
|
||
13. [Mapping values](./tutorial/13-map/)
|
||
14. [Adjusting map range](./tutorial/14-map-adjust/)
|
||
15. [Buttons](./tutorial/15-buttons/)
|
||
16. [Logic nodes](./tutorial/16-logic/)
|
||
17. [Reading lightness](./tutorial/17-ldr/)
|
||
18. [Comparing numbers](./tutorial/18-comparisons/)
|
||
19. [If-else branching](./tutorial/19-if-else/)
|
||
20. [Smoother changes](./tutorial/20-fade/)
|
||
21. [Pulses](./tutorial/21-pulses/)
|
||
22. [Clock](./tutorial/22-clock/)
|
||
23. [Pulse Counting](./tutorial/23-count/)
|
||
24. [Flip-flop](./tutorial/24-flip-flop/)
|
||
25. [Using Multiple Timelines](./tutorial/25-multiple-timelines/)
|
||
26. [Showing text on LCD](./tutorial/26-lcd/)
|
||
27. [Displaying sensor values on LCD](./tutorial/27-lcd-data/)
|
||
28. [String concatenation](./tutorial/28-string-concat/)
|
||
|
||
* [Complex projects?](./tutorial/complex-projects/)
|
||
|
||
User’s guide
|
||
------------
|
||
|
||
### Concepts
|
||
|
||
* [Program structure](./guide/program-structure/)
|
||
* [Data types](./guide/data-types/)
|
||
* [Linking rules](./guide/linking-rules/)
|
||
* [Execution model](./guide/execution-model/)
|
||
* [Variadic nodes](./guide/variadics/)
|
||
|
||
### Making your own nodes
|
||
|
||
* [Creating nodes for XOD in XOD](./guide/nodes-for-xod-in-xod/)
|
||
* [Creating analog sensor driver nodes](./guide/analog-sensor-node/)
|
||
* [Documenting nodes](./guide/documenting-nodes/)
|
||
* [Creating nodes for XOD in C++](./guide/nodes-for-xod-in-cpp/)
|
||
* [Dealing with state in C++](./guide/cpp-state/)
|
||
* [Dealing with time in C++](./guide/cpp-time/)
|
||
* [Creating variadic patch nodes](./guide/creating-variadics/)
|
||
|
||
### Doing things sequentially
|
||
|
||
* [Simple traffic light example](./guide/simple-traffic-light/)
|
||
|
||
### Projects and libraries
|
||
|
||
* [Working on projects](./guide/projects/)
|
||
* [Using libraries](./guide/using-libraries/)
|
||
* [Creating libraries](./guide/creating-libraries/)
|
||
|
||
Reference
|
||
---------
|
||
|
||
* [List of supported hardware](./reference/supported-hardware/)
|
||
* [Mouse and keyboard shortcuts](./reference/shortcuts/)
|
||
* [C++ node API reference](./reference/node-cpp-api/)
|
||
|
||
### Standard library nodes
|
||
|
||
* [`xod/core`](/libs/xod/core/)
|
||
* [`xod/common-hardware`](/libs/xod/common-hardware/)
|
||
* [`xod/units`](/libs/xod/units/)
|
||
* [`xod/bits`](/libs/xod/bits/)
|