├── .gitignore
├── Makefile
├── README.md
├── addons.js
├── bower.json
├── bower_components
└── jquery-scrollspy
│ ├── .eslintrc
│ ├── .gitignore
│ ├── README.md
│ ├── bower.json
│ ├── examples
│ ├── colors.html
│ └── fixednav.html
│ ├── gulpfile.js
│ ├── jquery-scrollspy.js
│ ├── jquery-scrollspy.min.js
│ ├── package.json
│ └── test
│ ├── demo.html
│ ├── memory-leak.coffee
│ └── memory-leak.js
├── docs
├── AZURE.md
├── CAYENNEAPI.md
├── CUSTOMWIDGETS.md
├── DOWNLOADS.md
├── FEATURES.md
├── GETTINGSTARTED.md
├── INTRO.md
├── IOTREADY.md
├── LORA.md
├── MQTTAPIS.md
├── SKETCHFILES.md
├── SUPPORTEDHARDWARE.md
└── TINA.md
├── examples
├── MQTT_EthernetShieldW5100_with_TMP36
│ └── MQTT_EthernetShieldW5100_with_TMP36.ino
└── README.md
├── flatdoc.js
├── img
├── expand.png
└── toggle.png
├── index.html
├── legacy.js
├── package.json
├── scrollspy.min.js
├── support
├── Notes.md
├── blur.jpg
├── dox2md.js
├── legacy-header.js
├── preview.jpg
├── theme.css
├── theme.js
└── vendor
│ ├── Makefile
│ ├── html5shiv.js
│ ├── jquery.fillsize.js
│ ├── jquery.js
│ ├── jquery.smartquotes.js
│ └── respond.js
└── theme-white
├── navbar-default.css
├── navbar.css
├── script.js
├── style.css
└── style.styl
/.gitignore:
--------------------------------------------------------------------------------
1 | .idea/
2 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | UGLIFY := ./node_modules/.bin/uglifyjs --comments "/^!/"
2 | STYLUS := ./node_modules/.bin/stylus -U -u nib
3 | DOX := ./node_modules/.bin/dox
4 |
5 | all: \
6 | legacy.js \
7 | theme-white/style.css \
8 | theme-white/script.js \
9 | Reference.md
10 |
11 | watch:
12 | while true; do make all | grep -v "Nothing"; sleep 1; done
13 |
14 | # Legacy shims for IE
15 | legacy.js: \
16 | support/legacy-header.js \
17 | support/vendor/html5shiv.js \
18 | support/vendor/respond.js
19 | cat $^ > $@
20 |
21 | %.css: %.styl
22 | (echo "/*\n\nPlease don't edit this file directly.\nInstead, edit the stylus (.styl) files and compile it to CSS on your machine.\n\n*/" ; $(STYLUS) < $<) > $@
23 |
24 | Reference.md: flatdoc.js
25 | $(DOX) -r < $< | node support/dox2md.js --default-level 3 > $@
26 |
27 | # $ make v/0.1.0
28 | # Makes a distribution.
29 | #
30 | v/%: all
31 | mkdir -p $@
32 | $(UGLIFY) < flatdoc.js > $@/flatdoc.js
33 | $(UGLIFY) < legacy.js > $@/legacy.js
34 | cp -R templates $@/templates
35 | mkdir -p $@/theme-white
36 | cp theme-white/style.css $@/theme-white
37 | cp theme-white/script.js $@/theme-white
38 |
39 | .PHONY: watch
40 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Welcome to the Cayenne Docs
2 |
3 | ## Introduction
4 | I will be walking you through editing content from Cayenne's boutiful Documentation setup. This is a work-in-progress, and collaboration is always encouraged.
5 |
6 |
7 | ## Important Links
8 | Markdown Cheatsheet (the syntax we will be using)
9 | https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
10 |
11 | MacDown (Markdown editor for Mac)
12 | http://macdown.uranusjr.com/
13 |
14 |
15 | ## Getting Started
16 | This section will highlight the common actions you might take while editing the docs. The instructions below describe the process using GitHub's built-in web editor.
17 |
18 | ### Switching to the Staging version
19 | Are you looking for the Staging version of the Docs? On the main repo page, right above the files, select the dropdown labeled Branch. From there, select the Staging branch. You are now in the Staging version of the Docs.
20 |
21 | ### Making a text edit
22 | Let's say you find something incorrectly written or you would like to update some text. First, you would find the main section the article is located in.
23 |
24 | **We'll use Getting Started for our example:**
25 |
26 | 1. Navigate to the Home directory of the repo by clicking cayenne-docs at the top of the page.
27 | 2. Then, select the docs directory by clicking the link.
28 | 3. In that folder, you will see the various high-level sections of the Docs. Select the GETTINGSTARTED.md by clicking it.
29 | 4. You will now see a preview of this section. Above the preview, on the grey bar, you will see a pencil icon. Click that to begin editing.
30 | 5. Find the portion of text you would like to edit. Make your changes, and then preview them by selecting the eye icon labeled "Preview changes".
31 | 6. Once you are satisfied with the results, click Commit changes.
32 | *(If you want to add some style, code, or specialized text, follow the link to the [Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) for a quick breakdown. If you want to add an image, follow the steps listed below.)*
33 |
34 | **Image Example Code**
35 | ```
36 |
37 |
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nihil opus est exemplis hoc facere longius. In his igitur partibus duabus nihil erat, quod Zeno commutare gestiret. Duo Reges: constructio interrete. Quid nunc honeste dicit? Age, inquies, ista parva sunt. Si id dicis, vicimus.
96 |Primum quid tu dicis breve? Nam ista vestra: Si gravis, brevis; Tollenda est atque extrahenda radicitus. Recte dicis; Est enim effectrix multarum et magnarum voluptatum. Vide ne ista sint Manliana vestra aut maiora etiam, si imperes quod facere non possim. Qua tu etiam inprudens utebare non numquam. Atque haec ita iustitiae propria sunt, ut sint virtutum reliquarum communia.
97 |98 | Nam neque virtute retinetur ille in vita, nec iis, qui sine 99 | virtute sunt, mors est oppetenda. 100 | 101 | Quid enim ab antiquis ex eo genere, quod ad disserendum 102 | valet, praetermissum est? 103 |104 |
Immo videri fortasse. Minime vero istorum quidem, inquit. Pugnant Stoici cum Peripateticis. Sed quot homines, tot sententiae;
105 |Haeret in salebra. Estne, quaeso, inquam, sitienti in bibendo voluptas? Octavio fuit, cum illam severitatem in eo filio adhibuit, quem in adoptionem D. 106 | Scrupulum, inquam, abeunti; De malis autem et bonis ab iis animalibus, quae nondum depravata sint, ait optime iudicari. Cum id fugiunt, re eadem defendunt, quae Peripatetici, verba. 107 |
108 |Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nihil opus est exemplis hoc facere longius. In his igitur partibus duabus nihil erat, quod Zeno commutare gestiret. Duo Reges: constructio interrete. Quid nunc honeste dicit? Age, inquies, ista parva sunt. Si id dicis, vicimus.
109 |Primum quid tu dicis breve? Nam ista vestra: Si gravis, brevis; Tollenda est atque extrahenda radicitus. Recte dicis; Est enim effectrix multarum et magnarum voluptatum. Vide ne ista sint Manliana vestra aut maiora etiam, si imperes quod facere non possim. Qua tu etiam inprudens utebare non numquam. Atque haec ita iustitiae propria sunt, ut sint virtutum reliquarum communia.
110 |111 | Nam neque virtute retinetur ille in vita, nec iis, qui sine 112 | virtute sunt, mors est oppetenda. 113 | 114 | Quid enim ab antiquis ex eo genere, quod ad disserendum 115 | valet, praetermissum est? 116 |117 |
Immo videri fortasse. Minime vero istorum quidem, inquit. Pugnant Stoici cum Peripateticis. Sed quot homines, tot sententiae;
118 |Haeret in salebra. Estne, quaeso, inquam, sitienti in bibendo voluptas? Octavio fuit, cum illam severitatem in eo filio adhibuit, quem in adoptionem D. 119 | Scrupulum, inquam, abeunti; De malis autem et bonis ab iis animalibus, quae nondum depravata sint, ait optime iudicari. Cum id fugiunt, re eadem defendunt, quae Peripatetici, verba. 120 |
121 |Lorem ipsum dolor sit amet, consectetur adipiscing elit. Dicet pro me ipsa virtus nec dubitabit isti vestro beato M. Sed residamus, inquit, si placet. Si quae forte-possumus. Quid censes in Latino fore? Duo Reges: constructio interrete. Nummus in Croesi divitiis obscuratur, pars est tamen divitiarum. An tu me de L. Quae contraria sunt his, malane? An potest, inquit ille, quicquam esse suavius quam nihil dolere? Itaque in rebus minime obscuris non multus est apud eos disserendi labor.
123 |124 | Omne enim animal, simul et ortum est, se ipsum et omnes partes suas diligit duasque, quae maximae sunt, in primis amplectitur, animum et corpus, deinde utriusque partes. 125 |126 |
Bonum incolumis acies: misera caecitas. Ego vero volo in virtute vim esse quam maximam; Traditur, inquit, ab Epicuro ratio neglegendi doloris. Quid de Platone aut de Democrito loquar? Inde igitur, inquit, ordiendum est. Philosophi autem in suis lectulis plerumque moriuntur. Quantum Aristoxeni ingenium consumptum videmus in musicis? Qui enim voluptatem ipsam contemnunt, iis licet dicere se acupenserem maenae non anteponere.
127 |Quorum altera prosunt, nocent altera. At, si voluptas esset bonum, desideraret. Haec para/doca illi, nos admirabilia dicamus. Et quidem iure fortasse, sed tamen non gravissimum est testimonium multitudinis. Illa argumenta propria videamus, cur omnia sint paria peccata. Hanc ergo intuens debet institutum illud quasi signum absolvere.
135 |GET | 66 |/auth/realms/cayenne/protocol/openid-connect/userinfo | 67 |
POST | 183 |/auth/realms/cayenne/protocol/openid-connect/token | 184 |
POST | 9 |IoT in a Box: https://hub.m2c.io/v1/networks/iotinabox/uplink Cayenne: https://hub.m2c.io/v1/networks/generic/uplink |
10 |
POST | 88 |https://hub.m2c.io/v1/networks/iotinabox/data | 89 |