Skip to content

Commit edcdac1

Browse files
authored
Update README.md
1 parent 2af1fc2 commit edcdac1

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,25 @@ The OOCSI mission is to create a simple systems-interaction fabric for use by de
66

77
OOCSI is a prototyping middleware for designing distributed products and it is targeted mainly at Industrial Design and Computer Science education. OOCSI supports multiple client platforms that allow prototyping connected products and systemic designs with various heterogeneous components from embedded to mobile to the cloud. In the past years, OOCSI has been used by hundreds of students, educators, and researchers, and it is continuously developed as an open-source project with feedback from the community.
88

9-
## Getting started
9+
There are many cases that OOCSI can support connected prototyping and communication between devices and platforms. For example, connecting a sensor on an embedded platform to a data logger or visualisation on a mobile device. Or connecting the sensor to other devices in the same context to share data within a local system. Using OOCSI is very simple and we have example code that covers many application cases.
1010

11-
There are many cases, in which OOCSI can support connected prototyping and communication between devices and platforms. For example, connecting a sensor on an embedded platform to a data logger or visualisation on a mobile device. Or connecting the sensor to other devices in the same context to share data within a local system.
11+
## Getting started
1212

13-
Before you head to our [wiki](https://github.com/iddi/oocsi/wiki), try to think about which types of devices or platforms you need to connect, then check the support platforms below. All repositories below have introductory information about how to connect to OOCSI.
13+
Our [wiki](https://github.com/iddi/oocsi/wiki) explains how to [get started](https://github.com/iddi/oocsi/wiki/Getting-started). Essentially, you need a server (or run your own) and then pick a client implementation for the platform that you are prototyping with (see below). For example, if you are designing a prototype based on an ESP32 and you would like to send data from this prototype to a Processing sketch to visualize the data, then you need to check out [OOCSI for ESP](https://github.com/iddi/oocsi-esp) and [OOCSI for Processing](https://github.com/iddi/oocsi-processing) to get started.
1414

1515
## Supported platforms
1616

17+
OOCSI supportes connected prototyping for the platforms or programming languages below. All repositories below have introductory information about how to connect to OOCSI.
18+
1719
* Processing ([GitHub repository](https://github.com/iddi/oocsi-processing))
1820
* Java/Android ([GitHub repository](https://github.com/iddi/oocsi))
1921
* Python ([GitHub repository](https://github.com/iddi/oocsi-python))
22+
* Micropython (ESP) ([GitHub repository](https://github.com/iddi/oocsi-micropython))
2023
* Javascript (HTML/Web) ([GitHub repository](https://github.com/iddi/oocsi-websocket))
2124
* Javascript (Node.js) ([GitHub repository](https://github.com/iddi/oocsi-nodejs))
22-
* ESP (via Arduino IDE) ([GitHub repository](https://github.com/iddi/oocsi-esp))
25+
* Arduino/ESP (via Arduino IDE) ([GitHub repository](https://github.com/iddi/oocsi-esp))
2326

24-
Find more information on client support [here](https://github.com/iddi/oocsi/wiki/OOCSI-clients).
27+
Find more information on client support [here](https://github.com/iddi/oocsi/wiki/OOCSI-clients). If you don't see what you looking for, contact us or create an issue with a feature request. Also, implementing your own platform client for OOCSI is straightforward, check the existing clients or the [protocol](https://github.com/iddi/oocsi/wiki/OOCSI-Protocol) for more information.
2528

2629
## Cite as
2730

0 commit comments

Comments
 (0)