Skip to content

Commit d383b41

Browse files
EllerbachEllerbach
authored
Adjusting device listing generation tool (#254)
1 parent 9aacc17 commit d383b41

File tree

11 files changed

+189
-91
lines changed

11 files changed

+189
-91
lines changed

Diff for: ‎README.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ Our samples uses 🌶️ to show how easy or complicated those samples are. The
2222

2323
### Special beginner
2424

25-
* [🌶️ - Blink your first led](samples/Blinky)
25+
* [🌶️ - Blink your first led](samples/Blinky)
2626
* [🌶️ - System.Device.Pwm](samples/PWM/System.Device.Pwm)
2727

2828
### Gpio, I2C, Spi, Pwm, Adc, Dac, 1-Wire, Serial
2929

30-
* [🌶️ - Blink your first led](samples/Blinky)
30+
* [🌶️ - Blink your first led](samples/Blinky)
3131
* [🌶️ - 1-Wire sample](samples/1-Wire)
3232
* [🌶️ - Analogic/Digital converter](samples/ADC)
3333
* [🌶️ - Analogic/Digital converter](samples/GiantGecko.Adc)
@@ -36,13 +36,13 @@ Our samples uses 🌶️ to show how easy or complicated those samples are. The
3636
* [🌶️ - GPIO and events sample (.NET IoT style)](samples/Gpio/Gpio+EventsIoTStyle)
3737
* [🌶️ - GPIO sample pack](samples/Gpio)
3838
* [🌶️ - System.Device.Pwm](samples/PWM/System.Device.Pwm)
39+
* [🌶️ - System.Device.PWM sample](samples/PWM)
3940
* [🌶️ - System.Device.Spi sample](samples/SPI)
4041
* [🌶️ to 🌶️🌶️ - System.IO.Ports serial Communication sample](samples/SerialCommunication)
4142
* [🌶️🌶️ - I2C GPS sample](samples/I2C/System.Device.I2c/GPS)
4243
* [🌶️🌶️ - I2C sample sample pack](samples/I2C)
4344
* [🌶️🌶️ - I2C Scanner sample](samples/I2C/NanoI2cScanner)
4445
* [🌶️🌶️🌶️ - Using Azure SDK with BMP280 on M5Stack with .NET nanoFramework](samples/AzureSDK/AzureSDKSensorCertificate)
45-
* [System.Device.PWM sample](samples/PWM)
4646

4747
### AMQP
4848

@@ -73,6 +73,7 @@ Our samples uses 🌶️ to show how easy or complicated those samples are. The
7373
* [🌶️ to 🌶️🌶️🌶️ - Bluetooth sample pack](samples/Bluetooth)
7474
* [🌶️🌶️ - Bluetooth Low energy: read static and dynamic values, notification, read/write value](samples/Bluetooth/BluetoothLESample1)
7575
* [🌶️🌶️ - Bluetooth Low energy: read/write with encryption a value](samples/Bluetooth/BluetoothLESample2)
76+
* [🌶️🌶️🌶️ - Improv Wifi provisioning](samples/Bluetooth/ImprovWifi)
7677

7778
### CAN
7879

@@ -88,11 +89,17 @@ Our samples uses 🌶️ to show how easy or complicated those samples are. The
8889
* [🌶️🌶️ - Ultrasonic HC-SR04 sensor with RMT](samples/Hardware.Esp32.Rmt/Ultrasonic)
8990
* [🌶️🌶️🌶️ - Complete Azure MQTT sample using BMP280 sensor **with** Azure lib and deep sleep](samples/AzureSDK/AzureSDKSleepBMP280)
9091
* [🌶️🌶️🌶️ - Complete Azure MQTT sample using BMP280 sensor **without Azure lib** and with deep sleep](samples/AzureMQTTTwinsBMP280Sleep)
92+
* [🌶️🌶️🌶️ - Improv Wifi provisioning](samples/Bluetooth/ImprovWifi)
9193

9294
### File and storage access
9395

9496
* [🌶️ - System.IO.FileSystem samples](samples/System.IO.FileSystem)
9597

98+
### Giant Gecko specific
99+
100+
* [🌶️ to 🌶️🌶️ - Giant Gecko hardware sample pack](samples/Hardware.GiantGecko)
101+
* [🌶️🌶️ - Giant Gecko Power Mode](samples/Hardware.GiantGecko/GiantGecko.PowerMode)
102+
96103
### Graphics for screens
97104

98105
* [🌶️🌶️ - Graphics Primitives](samples/Graphics/Primitives)
@@ -191,11 +198,6 @@ Our samples uses 🌶️ to show how easy or complicated those samples are. The
191198
* [🌶️ - WiFI samples](samples/Wifi)
192199
* [🌶️🌶️ - Wifi Soft AP sample](samples/WiFiAP)
193200

194-
### Giant Gecko specific
195-
196-
* [🌶️ to 🌶️🌶️ - Giant Gecko hardware sample pack](samples/Hardware.GiantGecko)
197-
* [🌶️🌶️ - Giant Gecko Power Mode](samples/Hardware.GiantGecko/GiantGecko.PowerMode)
198-
199201
</devices>
200202

201203
## Feedback and documentation

Diff for: ‎README.zh-cn.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@
2020

2121
### Special beginner
2222

23-
* [🌶️ - Blink your first led](samples/Blinky)
23+
* [🌶️ - Blink your first led](samples/Blinky)
2424
* [🌶️ - System.Device.Pwm](samples/PWM/System.Device.Pwm)
2525

2626
### Gpio, I2C, Spi, Pwm, Adc, Dac, 1-Wire, Serial
2727

28-
* [🌶️ - Blink your first led](samples/Blinky)
28+
* [🌶️ - Blink your first led](samples/Blinky)
2929
* [🌶️ - 1-Wire sample](samples/1-Wire)
3030
* [🌶️ - Analogic/Digital converter](samples/ADC)
3131
* [🌶️ - Analogic/Digital converter](samples/GiantGecko.Adc)
@@ -34,13 +34,13 @@
3434
* [🌶️ - GPIO and events sample (.NET IoT style)](samples/Gpio/Gpio+EventsIoTStyle)
3535
* [🌶️ - GPIO sample pack](samples/Gpio)
3636
* [🌶️ - System.Device.Pwm](samples/PWM/System.Device.Pwm)
37+
* [🌶️ - System.Device.PWM sample](samples/PWM)
3738
* [🌶️ - System.Device.Spi sample](samples/SPI)
3839
* [🌶️ to 🌶️🌶️ - System.IO.Ports serial Communication sample](samples/SerialCommunication)
3940
* [🌶️🌶️ - I2C GPS sample](samples/I2C/System.Device.I2c/GPS)
4041
* [🌶️🌶️ - I2C sample sample pack](samples/I2C)
4142
* [🌶️🌶️ - I2C Scanner sample](samples/I2C/NanoI2cScanner)
4243
* [🌶️🌶️🌶️ - Using Azure SDK with BMP280 on M5Stack with .NET nanoFramework](samples/AzureSDK/AzureSDKSensorCertificate)
43-
* [System.Device.PWM sample](samples/PWM)
4444

4545
### AMQP
4646

@@ -71,6 +71,7 @@
7171
* [🌶️ to 🌶️🌶️🌶️ - Bluetooth sample pack](samples/Bluetooth)
7272
* [🌶️🌶️ - Bluetooth Low energy: read static and dynamic values, notification, read/write value](samples/Bluetooth/BluetoothLESample1)
7373
* [🌶️🌶️ - Bluetooth Low energy: read/write with encryption a value](samples/Bluetooth/BluetoothLESample2)
74+
* [🌶️🌶️🌶️ - Improv Wifi provisioning](samples/Bluetooth/ImprovWifi)
7475

7576
### CAN
7677

@@ -86,11 +87,17 @@
8687
* [🌶️🌶️ - Ultrasonic HC-SR04 sensor with RMT](samples/Hardware.Esp32.Rmt/Ultrasonic)
8788
* [🌶️🌶️🌶️ - Complete Azure MQTT sample using BMP280 sensor **with** Azure lib and deep sleep](samples/AzureSDK/AzureSDKSleepBMP280)
8889
* [🌶️🌶️🌶️ - Complete Azure MQTT sample using BMP280 sensor **without Azure lib** and with deep sleep](samples/AzureMQTTTwinsBMP280Sleep)
90+
* [🌶️🌶️🌶️ - Improv Wifi provisioning](samples/Bluetooth/ImprovWifi)
8991

9092
### File and storage access
9193

9294
* [🌶️ - System.IO.FileSystem samples](samples/System.IO.FileSystem)
9395

96+
### Giant Gecko specific
97+
98+
* [🌶️ to 🌶️🌶️ - Giant Gecko hardware sample pack](samples/Hardware.GiantGecko)
99+
* [🌶️🌶️ - Giant Gecko Power Mode](samples/Hardware.GiantGecko/GiantGecko.PowerMode)
100+
94101
### Graphics for screens
95102

96103
* [🌶️🌶️ - Graphics Primitives](samples/Graphics/Primitives)
@@ -189,11 +196,6 @@
189196
* [🌶️ - WiFI samples](samples/Wifi)
190197
* [🌶️🌶️ - Wifi Soft AP sample](samples/WiFiAP)
191198

192-
### Giant Gecko specific
193-
194-
* [🌶️ to 🌶️🌶️ - Giant Gecko hardware sample pack](samples/Hardware.GiantGecko)
195-
* [🌶️🌶️ - Giant Gecko Power Mode](samples/Hardware.GiantGecko/GiantGecko.PowerMode)
196-
197199
</devices>
198200

199201
## 文档反馈

Diff for: ‎device-listing/Category.cs

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
// Licensed to the .NET Foundation under one or more agreements.
2+
// The .NET Foundation licenses this file to you under the MIT license.
3+
4+
namespace DdeviceListing
5+
{
6+
/// <summary>
7+
/// A category.
8+
/// </summary>
9+
internal class Category
10+
{
11+
/// <summary>
12+
/// Gets or sets the name of the category.
13+
/// </summary>
14+
public string Name { get; set; }
15+
16+
/// <summary>
17+
/// Gets or sets the description of the category.
18+
/// </summary>
19+
public string Description { get; set; }
20+
}
21+
}

Diff for: ‎device-listing/Configuration.cs

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// Licensed to the .NET Foundation under one or more agreements.
2+
// The .NET Foundation licenses this file to you under the MIT license.
3+
4+
using System.Collections.Generic;
5+
using DdeviceListing;
6+
7+
namespace DeviceListing
8+
{
9+
/// <summary>
10+
/// The configuration.
11+
/// </summary>
12+
internal class Configuration
13+
{
14+
/// <summary>
15+
/// Gets or sets the list of categories.
16+
/// </summary>
17+
public List<Category> Categories { get; set; }
18+
19+
/// <summary>
20+
/// Gets or sets the list of ignored folders.
21+
/// </summary>
22+
public string[] Ignored { get; set; }
23+
}
24+
}

Diff for: ‎device-listing/Configuration.json

+103
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
{
2+
"Categories": [
3+
{
4+
"Name": "beginner",
5+
"Description": "Special beginner"
6+
},
7+
{
8+
"Name": "device",
9+
"Description": "Gpio, I2C, Spi, Pwm, Adc, Dac, 1-Wire, Serial"
10+
},
11+
12+
{
13+
"Name": "amqp",
14+
"Description": "AMQP"
15+
},
16+
{
17+
"Name": "aws",
18+
"Description": "AWS specific"
19+
},
20+
{
21+
"Name": "azure",
22+
"Description": "Azure specific"
23+
},
24+
{
25+
"Name": "ble",
26+
"Description": "Bluetooth"
27+
},
28+
{
29+
"Name": "can",
30+
"Description": "CAN"
31+
},
32+
{
33+
"Name": "esp32",
34+
"Description": "ESP32 specific"
35+
},
36+
{
37+
"Name": "file",
38+
"Description": "File and storage access"
39+
},
40+
{
41+
"Name": "ggecko",
42+
"Description": "Giant Gecko specific"
43+
},
44+
{
45+
"Name": "graphics",
46+
"Description": "Graphics for screens"
47+
},
48+
{
49+
"Name": "iot-device",
50+
"Description": "IoT.Device"
51+
},
52+
{
53+
"Name": "interop",
54+
"Description": "Interop"
55+
},
56+
{
57+
"Name": "json",
58+
"Description": "Json"
59+
},
60+
{
61+
"Name": "mqtt",
62+
"Description": "MQTT"
63+
},
64+
{
65+
"Name": "networking",
66+
"Description": "Networking including HTTP, SSL"
67+
},
68+
{
69+
"Name": "reader",
70+
"Description": "Readers"
71+
},
72+
{
73+
"Name": "rtc",
74+
"Description": "Real Time Clock"
75+
},
76+
{
77+
"Name": "stm32",
78+
"Description": "STM32 Specific"
79+
},
80+
{
81+
"Name": "ti",
82+
"Description": "Texas Instrument specific"
83+
},
84+
{
85+
"Name": "tools",
86+
"Description": "Tools and utilities"
87+
},
88+
{
89+
"Name": "system",
90+
"Description": "System related"
91+
},
92+
{
93+
"Name": "wifi",
94+
"Description": "Wifi"
95+
}
96+
],
97+
"Ignored": [
98+
"Archive",
99+
"packages",
100+
"bin",
101+
"obj"
102+
]
103+
}

0 commit comments

Comments
 (0)