Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davwheat/mobile-spectrum-data
Data related to mobile networking spectrum around the world, including ARFCNs, descriptions, and more.
https://github.com/davwheat/mobile-spectrum-data
hacktoberfest
Last synced: 17 days ago
JSON representation
Data related to mobile networking spectrum around the world, including ARFCNs, descriptions, and more.
- Host: GitHub
- URL: https://github.com/davwheat/mobile-spectrum-data
- Owner: davwheat
- License: lgpl-3.0
- Created: 2022-07-03T16:31:33.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-14T00:22:05.000Z (2 months ago)
- Last Synced: 2024-10-13T20:12:19.329Z (about 1 month ago)
- Topics: hacktoberfest
- Language: TypeScript
- Homepage: https://mastdatabase.co.uk/
- Size: 7.01 MB
- Stars: 5
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mobile spectrum data
This repository contains data related to mobile networking spectrum around the world, including ARFCNs, descriptions, and more.
I use this data for my own open-source mobile networking website: https://mastdatabase.co.uk
This dataset is [licensed under the GNU LGPLv3 license](./LICENSE).
- [Supported countries](#supported-countries)
- [Package structure](#package-structure)
- [Spectrum allocation and usage](#spectrum-allocation-and-usage)
- [LTE and NR band data](#lte-and-nr-band-data)
- [Editing spectrum](#editing-spectrum)
- [Developer documentation](#developer-documentation)
- [Testing changes](#testing-changes)
## Supported countries
Countries with data in this package are included below. If yours is misisng, why not contribute?
| Country |
| ---------------------- |
| 🇦🇹 Austria |
| 🇧🇬 Bulgaria |
| 🇩🇪 Germany |
| 🇩🇰 Denmark |
| 🇪🇪 Estonia |
| 🇫🇮 Finland (and Åland) |
| 🇬🇧 United Kingdom |
| 🇭🇺 Hungary |
| 🇮🇪 Ireland |
| 🇮🇹 Italy |
| 🇯🇲 Jamaica |
| 🇰🇷 South Korea |
| 🇱🇹 Lithuania |
| 🇱🇻 Latvia |
| 🇲🇰 North Macedonia |
| 🇵🇹 Portugal |
| 🇷🇴 Romania |
| 🇷🇸 Serbia |
| 🇷🇺 Russia |
| 🇹🇹 Trinidad and Tobago |
| 🇺🇦 Ukraine |
## Package structure
This package includes typings declarations for all exported data. Your IDE should use these to detect and prevent syntax errors in your code.
### Spectrum allocation and usage
A country's sepctrum data can be imported by its two-letter ISO country code.
For example, to import the UK's spectrum data, you would do:
```ts
import SpectrumDataGB from "mobile-spectrum-data/GB";
```
This imported data will be an array of Javascript objects with the keys `names` and `spectrumData`.
```ts
{
names: ["B8", "n8"],
spectrumData: [ /* ... */ ]
}
```
You can also import data for specific bands individually. This is allowed, and can be used to prevent loading more data than needed, but is considered internal and your imports _could_ break between versions (but are very unlikely to).
Sometimes multiple bands are contained within one single file. A good example of this is Denmark, with Bands 32, 75 and 76 being in the same file and spectrum allocation list due to Bands 75 and 76 being extensions of Band 32.
```ts
import Band8GB from "mobile-spectrum-data/GB/8";
import Band32_75_76DK from "mobile-spectrum-data/DK/32_75_76";
```
## LTE and NR band data
This package also contains a list of all LTE and NR bands, along with useful metadata about them.
This includes the human names for them, start and end frequencies, the offset used for DL and UL ARFCN calculation and more.
This can be imported from the BandInfo folder.
> Please note that ARFCN offsets are not currently included for NR.
```ts
import { LTEBandData, NRBandData } from "mobile-spectrum-data/BandInfo";
// or...
import { LTEBandData } from "mobile-spectrum-data/BandInfo/LTEBandData";
import { NRBandData } from "mobile-spectrum-data/BandInfo/NRBandData";
```
## Editing spectrum
Need help editing spectrum? Try [my GUI spectrum editor](https://mastdatabase.co.uk/spectrum-editor).
## Developer documentation
### Testing changes
To test alongside [mastdatabase.co.uk](https://mastdatabase.co.uk/), you should:
1. Clone both repos locally and check out the appropriate branch(es).
2. Install dependencies in both repos (run `yarn`).
3. In `mobile-spectrum-data`, run `yarn pub`. When asked for an OTP, hit `Ctrl + C` to cancel.
4. In `mobile-spectrum-data`, delete the `package.json` and `yarn.lock` temporarily.
5. In `mastdatabase.co.uk`, run `yarn link path/to/mobile-spectrum-data/publish-tmp`.
6. Launch `mastdatabase.co.uk` locally with `yarn develop`.
7. Test your changes!