Updated Home (markdown)

Oliver Schmidt
2018-10-28 22:31:48 +01:00
parent e6dedbb3fe
commit 27bc95023b

175
Home.md

@@ -1,174 +1 @@
<!-- Non-breaking space in anchor tags required by Safari, when link comes from another page. -->
Welcome to the Contiki wiki! The main sections are available from the table below, or from the sidebar at right, which appears on each page. So explore, you won't get lost. :-)
<table
<!-- Must use this literal link syntax to satisfy Safari. -->
<tr>
<td>[Develop](#wiki-Develop)</td><td>Guides and tips on getting started, configuration and tuning</td>
</tr><tr>
<td>[Platforms](#wiki-Platforms)</td><td>Guides to specific hardware</td>
</tr><tr>
<td>[Internals](#wiki-Internals)</td><td>Details on Contiki's organization and subsystems</td>
</tr><tr>
<td>[Community](#wiki-Community)</td><td>Links to Contiki-related projects and enhancements developed by users</td>
</tr><tr>
<td>[Help](#wiki-Help)</td><td>Links to resources like the mailing list and issue tracker</td>
</tr>
</table>
Have a tip or project to share? Add it to the wiki! All you need is a free GitHub account.
Have code you'd like to contribute? Great! See [[Code-Contributions]] to submit and include it in the Contiki tree.
***
<a name="Develop">&nbsp;</a>
Develop
=======
Guides and tips on getting started, configuration and tuning.
Getting Started
---------------
* [[Instant Contiki install scripts]]
* [[Setup Contiki Toolchain in Ubuntu 13.04]]
Building
--------
* [[Contiki-Build-System]]
* [[Reducing Contiki OS firmware size]]
* [[Creating "out-of-tree" project, apps, and targets using Git Submodules|Out of Tree Development]]
Simulation
----------
* [[An Introduction to Cooja]]
* [[Using Cooja Test Scripts to Automate Simulations]]
Other
----
* [[File systems]] - how to use the CFS APIs and Coffee FS configuration parameters
* [[Coffee filesystem example]] - walkthrough of using Coffee FS
* [[Debugging System: Ideas on how to improve the debugging system]]
* [[Webserver nano_AJAX_streaming_Example_Guide]]
* [[Configuring HTTP Proxy]]
***
<a name="Platforms">&nbsp;</a>
Platforms
=========
The repository includes ports for several hardware platforms. Drill down for implementation specifics.
* [[AVR|Avr Platforms]]
* [mc13224v-based](http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MC13224V)
* [M12](http://www.redwirellc.com/store/node/6) - FCC approved mc13224v module
* [TH12](http://www.redwirellc.com/store/node/7) - Temperature and humidity sensor and development platform
* [[Econotags]] - mc13224v development board with on board JTAG.
* [RL78](http://www.renesas.com/products/mpumcu/rl78/index.jsp?campaign=gn_prod) + [ADF7023](http://www.analog.com/en/rfif-components/rfif-transceivers/adf7023-j/products/product.html) sub-GHz platform - [eval-adf7023](http://www.analog.com/en/evaluation/eval-adf7023/eb.html) eval board from Analog Devices. See platform [README](https://github.com/contiki-os/contiki/tree/master/platform/eval-adf7xxxmb4z) for how to get started.
* [[Host Subprocesses|Native, minimal-net]] (native, minimal-net)
* [[Java|An Introduction to Cooja]] (Cooja motes)
* [[8051-Based-Platforms]] (TI cc2530 DK and Sensinode/cc2430)
* [[Zolertia-z1-motes]] (MSP430x2 + CC2420 based)
* TI CC2538 Development Kit, documented in the [README under the platform dir](https://github.com/contiki-os/contiki/blob/master/platform/cc2538dk/README.md)
There are also platforms that are no longer in the main tree:
* [[Lost platforms]]
Border-routers and gateways
---------------------------
Some routers and gateways run Contiki and others are simply useful for setting up 6LowPAN networks
* [BR12](http://www.redwirellc.com/store/node/9) - embedded Linux based 6LoWPAN router (includes the [BRamble](http://malvira.github.com/bramble/) 6LoWPAN administration frontend)
* [red-IO](http://www.redwirellc.com/store/node/13) Contiki-based router. Can run [Mist](http://thingsqare.com/mist)(Nat64/DNS64) or [6lbr](https://github.com/cetic/6lbr)(native ipv6 routing)
Also see links to out of tree implementations in the [Community](#wiki-Community) section below.
***
<a name="Internals">&nbsp;</a>
Internals
=========
Details on Contiki's organization and subsystems.
* [[Processes]]
* [[Timers]]
* [[Callback timer]]
* [[Memory allocation]]
* [[Input and output]]
* [[Libraries]]
* [[File systems]]
* [[The dynamic loader]]
* [[Multithreading]]
* [[RPL modes]]
Duty Cycling
------------
* [[Radio duty cycling]]
* [[Change MAC or Radio Duty Cycling Protocols]]
* Information about [[ContikiMAC]]
***
<a name="Community">&nbsp;</a>
Community
=========
Projects and enhancements developed by Contiki users, not in the main Contiki tree.
* Some projects are hosted/mirrored in the [Contiki Projects](http://contikiprojects.svn.sourceforge.net/viewvc/contikiprojects/) repository on SourceForge.
Contiki ports and platforms
---------------------------
* [JenniSense](https://github.com/teco-kit/Jennisense) NXP/Jennic JN51xx ieee802.15.4 SoC and open hardware schematics
* [Contiki-Senslab](https://gforge.inria.fr/projects/contiki-senslab/Contiki-Senslab) Contiki port for [Senslab](http://www.senslab.info/) nodes, including a CC1101 radio driver
* [contiki-avr-zigduino](http://github.com/maniacbug/contiki-avr-zigduino)
* [contiki-arduino](http://github.com/contiki/contiki-arduino), [contiki-arduino-2.2](http://github.com/contiki/contiki-arduino-2.2)
* [contiki-dspic](https://github.com/shuckc/contiki-dspic) Contiki port for Microchip dsPIC micro-controller (cpu + board support 'platform' for Dangerous Prototypes [Web Platform](http://dangerousprototypes.com/docs/Web_Platform))
* [BatMote](http://www.batmote.net/), a small size, low cost, WSN platform with Contiki support, based on Atmega128RFA1.
* [Flexibity Sensors](http://www.flexibity.com/), DIY home sensors platform with Cosm integration based on MC13224V, Contiki and OpenWRT.
Contiki enhancements
--------------------
* [Collection of Cooja and Contiki patches](http://i4git.informatik.uni-erlangen.de/contiki.git/shortlog/refs/heads/patches)
* [Contiki BBS](http://contikiprojects.svn.sourceforge.net/viewvc/contikiprojects/ufud.org/contiki-bbs/): A simple telnet BBS server for the Commodore 64 homecomputer based on Contiki.
* [Minilink](http://sourceforge.net/p/contikiprojects/code/HEAD/tree/uni-erlangen.de/Minilink/): An improved linker for Contiki (for MSP430-based Nodes only).
* [Migmem](http://sourceforge.net/p/contikiprojects/code/HEAD/tree/uni-erlangen.de/Minilink/): A library to serialize applications and migrate their memory. Bases on the Minilink linker.
* [Rudolph1 ported to unicast on top of Mesh](http://sourceforge.net/p/contikiprojects/code/HEAD/tree/uni-erlangen.de/rudolph1mh/)
* [[6LP-GW]] Implementation of a 6LoWPAN Neighbor Discovery Proxy gateway.
* [6LoWPAN-ND implementation](http://code.google.com/p/6lowpan-nd/). An implementation of the Neighbor Discovery Optimization for LLNs ([draft-ietf-6lowpan-nd-18](http://tools.ietf.org/html/draft-ietf-6lowpan-nd-18)) for Contiki.
* [6LBR for RPL](https://github.com/cetic/6lbr/wiki): an implementation of a RPL-friendly 6LoWPAN Border Router
* [T-Res](https://github.com/tecip-nes/contiki-tres/wiki/tres-overview): a programming abstraction framework enabling re-configurable in-network processing in IoT-based WSNs.
Cooja plugins
-------------
* [GDBStub for Sky Motes](https://github.com/cmorty/cooja-gdbstub)
* [CoojaTrace](https://github.com/cmorty/coojatrace): A framework to trace and log data using Cooja. Extensions are [CoojaTracePlot](https://github.com/cmorty/coojatraceplot) to plot the data in Cooja and [CoojaTraceSQLite](https://github.com/cmorty/coojatracesqlite) to log the data to an SQLite database.
* [Serial2pty](https://github.com/cmorty/cooja-serial2pty): Creates a real serial device for a virtual mote.
* [Mobility COOJA plugin](http://sourceforge.net/p/contikiprojects/code/HEAD/tree/sics.se/mobility/): The Mobility plugin for Cooja allows using a data file with positions over time for the nodes in the simulation.
* [Kleenet COOJA project](http://contikiprojects.svn.sourceforge.net/viewvc/contikiprojects/sics.se/coojakleenet/): Integrate Kleenet into Cooja.
* [RealSim](https://github.com/cmorty/realsim) tries to map a real network to Cooja. Can be used to configure DGRM over time, too.
* [Headless Radio Logger](https://github.com/cetic/cooja-radiologger-headless): Generate PCAP files in headless mode.
Cooja enhancements
------------------
* [PPA for Ubuntu](https://launchpad.net/~morty/+archive/cooja)
* [A slider to change the values of the light sensor](http://contikiprojects.svn.sourceforge.net/viewvc/contikiprojects/uni-erlangen.de/COOJA_SKY_LightSlider/)
* [Power Tracker](http://contikiprojects.svn.sourceforge.net/viewvc/contikiprojects/sics.se/powertracker/) A Cooja plugin that shows a window with the average duty cycle of the Tmote Sky radio. This can be used to measure the power consumption of the network as well as to assess the power overhead of a duty cycling MAC protocol.
* [csc2svg](http://i4git.cs.fau.de/contiki_projects.git/tree/csc2svg) extracts the network topology from a csc file and saves it as svg.
* [cooja-dbus](https://github.com/ltworf/cooja-dbus) uses dbus to let external programs control the simulation.
Collect-view
------------
* [sky-boards-collect](http://code.google.com/p/sky-boards-collect/), an extension to contiki-collect-sky-2.5.
***
<a name="Help">&nbsp;</a>
Help
====
<table>
<tr>
<td>Website</td><td>Check the <a href="http://www.contiki-os.org/">Contiki website</a></td>
</tr><tr>
<td>Stackoverflow</td><td>Submit your questions with the <a href="http://stackoverflow.com/questions/tagged/contiki">Contiki tag on Stackoverflow</a></td>
</tr><tr>
<td>Bug reports</td><td>Use the <a href="https://github.com/contiki-os/contiki/issues?state=open">Issue Tracker</a> provided by Github.</td>
</tr><tr>
<td>Mailing List</td><td>For Contiki development discussion use the <a href="https://lists.sourceforge.net/lists/listinfo/contiki-developers">mailing list home</a> or <a href="http://dir.gmane.org/gmane.os.contiki.devel">Gmane archive</a></td>
</tr><tr>
<td>IRC</td><td>Join #contiki-os channel at irc.freenode.net for <a href="http://freenode.net/irc_servers.shtml">live community discussion</a></td>
</tr>
</table>
### Contiki