Skip to content

Commit 45b561b

Browse files
authored
docs: update readme (#1920)
1 parent 1a1c92e commit 45b561b

File tree

1 file changed

+24
-21
lines changed

1 file changed

+24
-21
lines changed

README.md

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@
99
[![Mailing List](https://img.shields.io/badge/Mailing%20List-FOSSASIA-blue.svg)](https://groups.google.com/forum/#!forum/pslab-fossasia)
1010
[![Twitter Follow](https://img.shields.io/twitter/follow/pslabio.svg?style=social&label=Follow&maxAge=2592000?style=flat-square)](https://twitter.com/pslabio)
1111

12+
![Minimum API Level](https://img.shields.io/badge/Min%20API%20Level-23-green)
13+
![Maximum API Level](https://img.shields.io/badge/Max%20API%20Level-28-orange)
14+
![GitHub repo size](https://img.shields.io/github/repo-size/fossasia/pslab-android)
15+
1216
This repository holds the Android App for performing experiments with [PSLab](https://pslab.io/). PSLab is a tiny pocket science lab that provides an array of equipment for doing science and engineering experiments. It can function like an oscilloscope, waveform generator, frequency counter, programmable voltage and current source and also as a data logger. Our website is at https://pslab.io
1317

1418
## Communication
@@ -19,8 +23,8 @@ Please join us on the following channels:
1923

2024
## Roadmap
2125
- [x] First we need to get communication between Android App and PSLab working.
22-
- [ ] Implement Applications and expose PSLab Hardware functionality to the user.
23-
- [ ] Implement Functionality to Perform Experiment using PSLab Hardware Device.
26+
- [x] Implement Applications and expose PSLab Hardware functionality to the user.
27+
- [ ] Implement wireless connectivity
2428

2529
## Screenshots
2630

@@ -94,27 +98,26 @@ Please join us on the following channels:
9498
- [Generating and Observing Waveforms Using Pocket Science Lab](https://www.youtube.com/watch?v=Ua9_OCR4p8Y)
9599

96100
## Features
97-
| **Feature** | **Description** | **Status** |
98-
|------------------|-------------------------------------------------------|-----------------|
99-
| Home Screen | Show status and version of PSLab device | |
100-
| Instruments | Exposes PSLab instruments like Oscilloscope, etc | |
101-
| Oscilloscope | Shows variation of analog signals | |
102-
| Multimeter | Measures voltage, current, resistance and capacitance | |
103-
| Logical Analyzer | Captures and displays signals from digital system | |
104-
| Wave Generator | Generates arbitrary analog and digital waveforms | |
105-
| Power Source | Generates programmable voltage and currents | |
106-
| Lux Meter | Measures the ambient light intensity | |
107-
| Baro Meter | Measures the Pressure | |
108-
| AcceleroMeter | Measures the acceleration of the device | |
109-
| Gyro Meter | Measures the rate of rotation | |
110-
| Compass | Measures the absolute rotation relative to earth magnetic poles | |
111-
| Thermometer | Measures the ambient temperature | |
112-
| Robotic Arm Controller | Allows to control 4 servo motors of the robotic arm independently| |
113-
## How to set up the Android app in your development environment
101+
| **Feature** | **Description** | **Status** |
102+
|------------------------|-------------------------------------------------------------------|--------------------|
103+
| Home Screen | Show status and version of PSLab device | :heavy_check_mark: |
104+
| Instruments | Exposes PSLab instruments like Oscilloscope, etc | :heavy_check_mark: |
105+
| Oscilloscope | Shows variation of analog signals | :heavy_check_mark: |
106+
| Multimeter | Measures voltage, current, resistance and capacitance | :heavy_check_mark: |
107+
| Logical Analyzer | Captures and displays signals from digital system | :heavy_check_mark: |
108+
| Wave Generator | Generates arbitrary analog and digital waveforms | :heavy_check_mark: |
109+
| Power Source | Generates programmable voltage and currents | :heavy_check_mark: |
110+
| Lux Meter | Measures the ambient light intensity | :heavy_check_mark: |
111+
| Baro Meter | Measures the Pressure | :heavy_check_mark: |
112+
| AcceleroMeter | Measures the acceleration of the device | :heavy_check_mark: |
113+
| Gyro Meter | Measures the rate of rotation | :heavy_check_mark: |
114+
| Compass | Measures the absolute rotation relative to earth magnetic poles | :heavy_check_mark: |
115+
| Thermometer | Measures the ambient temperature | :heavy_check_mark: |
116+
| Gas Sensor | Detects gases, including NH3, NOx, alcohol, benzene, smoke and CO2| :heavy_check_mark: |
117+
| Robotic Arm Controller | Allows to control 4 servo motors of the robotic arm independently | :heavy_check_mark: |
114118

115-
Minimum Android version 6.0 (API Level 23)
119+
## How to set up the Android app in your development environment
116120

117-
Maximum Android version 8.1 (API Level 27)
118121

119122
### Application Flavors
120123

0 commit comments

Comments
 (0)