doc/contiki-mainpage.txt

   1 /**
   2
   3 \mainpage The Contiki Operating System
   4
   5 Contiki is an open source, highly portable, multi-tasking operating
   6 system for memory-efficient networked embedded systems and wireless
   7 sensor networks.  Contiki is designed for microcontrollers with small
   8 amounts of memory. A typical Contiki configuration is 2 kilobytes of
   9 RAM and 40 kilobytes of ROM.
  10
  11 Contiki provides IP communication, both for IPv4 and IPv6. Contiki and
  12 its uIPv6 stack are IPv6 Ready Phase 1 certified and therefor has the
  13 right to use the IPv6 Ready silver logo.
  14
  15 Many key mechanisms and ideas from Contiki have been widely adopted in
  16 the industry. The uIP embedded IP stack, originally released in 2001,
  17 is today used by hundreds of companies in systems such as freighter
  18 ships, satellites and oil drilling equipment. Contiki and uIP are
  19 recognized by the popular nmap network scanning tool. Contiki's
  20 protothreads, first released in 2005, have been used in many different
  21 embedded systems, ranging from digital TV decoders to wireless
  22 vibration sensors.
  23
  24 Contiki introduced the idea of using IP communication in low-power
  25 sensor networks networks. This subsequently lead to an IETF standard
  26 and the IPSO Aliance, an international industry alliance. TIME
  27 Magazine listed Internet of Things and the IPSO Alliance as the 30th
  28 most important innovation of 2008.
  29
  30 Contiki is developed by a group of developers from industry and
  31 academia lead by Adam Dunkels from the Swedish Institute of Computer
  32 Science. The Contiki team currently consists of sixteen developers
  33 from SICS, SAP AG, Cisco, Atmel, NewAE and TU Munich.
  34
  35 Contiki contains two communication stacks: \ref uip "uIP" and \ref
  36 rime "Rime". uIP is a small RFC-compliant TCP/IP stack that makes it
  37 possible for Contiki to communicate over the Internet. Rime is a
  38 lightweight communication stack designed for low-power radios. Rime
  39 provides a wide range of communication primitives, from \ref rimeabc
  40 "best-effort local area broadcast", to \ref rudolph1
  41 "reliable multi-hop bulk data flooding".
  42
  43 Contiki runs on a variety of platform ranging from embedded
  44 microcontrollers such as the MSP430 and the AVR to old
  45 homecomputers. Code footprint is on the order of kilobytes and memory
  46 usage can be configured to be as low as tens of bytes.
  47
  48 Contiki is written in the C programming language and is freely
  49 available as open source under a BSD-style license.
  50
  51 \section contiki-mainpage-tcpip TCP/IP
  52
  53 Contiki includes the uIP TCP/IP stack (http://www.sics.se/~adam/uip/)
  54 that provides Contiki with TCP/IP networking support. uIP provides the
  55 protocols TCP, UDP, IP, and ARP.
  56
  57 \sa \ref uip "The uIP TCP/IP stack documentation"
  58 \sa \ref tcpip "The Contiki/uIP interface"
  59 \sa \ref psock "Protosockets library"
  60
  61 \section contiki-mainpage-rime Rime
  62
  63 Rime is a lightweight communication stacks designed for low-power
  64 radios. Rime provides a wide range of communication primitives
  65 suitable for implementing communication-bound applications or network
  66 protocols.
  67
  68 \sa \ref rime "The Rime Communication Stack"
  69
  70 \section contiki-mainpage-threads Multi-threading and protothreads
  71
  72 Contiki is based on an event-driven kernel but provides support for
  73 both multi-threading and a lightweight stackless thread-like construct
  74 called protothreads.
  75
  76 \sa \ref process "Contiki processes"
  77 \sa \ref pt "Protothreads"
  78 \sa \ref etimer "Event timers"
  79 \sa \ref mt "Optional multi-threading"
  80
  81 \section contiki-mainpage-lib Libraries
  82
  83 Contiki provides a set of convenience libraries for memory management
  84 and linked list operations.
  85
  86 \sa \ref timer "Simple timer library"
  87 \sa \ref memb "Memory block management"
  88 \sa \ref list "Linked list library"
  89
  90 \section contiki-mainpage-getting-started Getting started with Contiki
  91
  92 Contiki is designed to run on many different \ref platform "platforms". It is also
  93 possible to compile and build both the Contiki system and Contiki
  94 applications on many different development platforms.
  95
  96 See \ref esb-getting-started "Getting started with Contiki for the ESB platform
  97
  98 \section contiki-mainpage-building Building the Contiki system and its applications
  99
 100  The Contiki build system is designed to make it easy to compile
 101  Contiki applications for either to a hardware platform or into a
 102  simulation platform by simply supplying different parameters to the
 103  <tt>make</tt> command, without having to edit makefiles or modify
 104  the application code.
 105
 106 See \ref buildsystem
 107
 108
 109 */