Meshtastic-Apple/Meshtastic/Enums/LoraConfigEnums.swift
Blake McAnally 58da532d32 Extract the generated protobufs into its own Swift package
This change modifies the process for generating and integrating the Meshtastic protobufs into the client application.

* The generated Swift code is now in a local SPM package `MeshtasticProtobufs`
* An Xcode Workspace file `Meshtastic.xcworkspace` was created to more easily manage the new build targets.
* The code generation script for the protos was modified to generate the Swift code into the new location.
* The README.md was updated to reflect these changes.

NOTE: After merging this PR, do not open the project file `Meshtastic.xcodeproj`. You must use the workspace `Meshtastic.xcworkspace`

Extracting out the generated protobuf code into its own library enables several opportunities for the project. This is just a first step, but with some more modularization, a standalone Apple Watch app or other targets starts to become a little bit more achievable to implement.

After extracting the protobufs into a Swift package, I validate these changes by building and running the Meshtastic app to an iPhone 15 Pro Max, and tried changing some settings on a local node. I then messaged back and forth using two local nodes connected to two different iOS devices.
2024-06-28 11:11:01 -05:00

320 lines
5.9 KiB
Swift

//
// LoraConfig.swift
// Meshtastic
//
// Copyright(c) Garth Vander Houwen 8/20/22.
//
import Foundation
import MeshtasticProtobufs
enum RegionCodes: Int, CaseIterable, Identifiable {
case unset = 0
case us = 1
case eu433 = 2
case eu868 = 3
case cn = 4
case jp = 5
case anz = 6
case kr = 7
case tw = 8
case ru = 9
case `in` = 10
case nz865 = 11
case th = 12
case ua433 = 14
case ua868 = 15
case my_433 = 16
case my_919 = 17
case sg_923 = 18
case lora24 = 13
var topic: String {
switch self {
case .unset:
"UNSET"
case .us:
"US"
case .eu433:
"EU_433"
case .eu868:
"EU_868"
case .cn:
"CN"
case .jp:
"JP"
case .anz:
"ANZ"
case .kr:
"KR"
case .tw:
"TW"
case .ru:
"RU"
case .in:
"IN"
case .nz865:
"NZ_865"
case .th:
"TH"
case .ua433:
"UA_433"
case .ua868:
"UA_868"
case .my_433:
"MY_433"
case .my_919:
"MY_919"
case .sg_923:
"SG_923"
case .lora24:
"LORA_24"
} }
var id: Int { self.rawValue }
var description: String {
switch self {
case .unset:
return "Please set a region"
case .us:
return "United States"
case .eu433:
return "European Union 433mhz"
case .eu868:
return "European Union 868mhz"
case .cn:
return "China"
case .jp:
return "Japan"
case .anz:
return "Australia / New Zealand"
case .kr:
return "Korea"
case .tw:
return "Taiwan"
case .ru:
return "Russia"
case .in:
return "India"
case .nz865:
return "New Zealand 865mhz"
case .th:
return "Thailand"
case .ua433:
return "Ukraine 433mhz"
case .ua868:
return "Ukraine 868mhz"
case .lora24:
return "2.4 GHZ"
case .my_433:
return "Malaysia 433mhz"
case .my_919:
return "Malaysia 919mhz"
case .sg_923:
return "Singapore 923mhz"
}
}
var dutyCycle: Int {
switch self {
case .unset:
return 0
case .us:
return 100
case .eu433:
return 10
case .eu868:
return 10
case .cn:
return 100
case .jp:
return 100
case .anz:
return 100
case .kr:
return 100
case .tw:
return 100
case .ru:
return 100
case .in:
return 100
case .nz865:
return 100
case .th:
return 100
case .ua433:
return 10
case .ua868:
return 10
case .lora24:
return 100
case .my_433:
return 100
case .my_919:
return 100
case .sg_923:
return 100
}
}
func protoEnumValue() -> Config.LoRaConfig.RegionCode {
switch self {
case .unset:
return Config.LoRaConfig.RegionCode.unset
case .us:
return Config.LoRaConfig.RegionCode.us
case .eu433:
return Config.LoRaConfig.RegionCode.eu433
case .eu868:
return Config.LoRaConfig.RegionCode.eu868
case .cn:
return Config.LoRaConfig.RegionCode.cn
case .jp:
return Config.LoRaConfig.RegionCode.jp
case .anz:
return Config.LoRaConfig.RegionCode.anz
case .kr:
return Config.LoRaConfig.RegionCode.kr
case .tw:
return Config.LoRaConfig.RegionCode.tw
case .ru:
return Config.LoRaConfig.RegionCode.ru
case .in:
return Config.LoRaConfig.RegionCode.in
case .nz865:
return Config.LoRaConfig.RegionCode.nz865
case .th:
return Config.LoRaConfig.RegionCode.th
case .ua433:
return Config.LoRaConfig.RegionCode.ua433
case .ua868:
return Config.LoRaConfig.RegionCode.ua868
case .lora24:
return Config.LoRaConfig.RegionCode.lora24
case .my_433:
return Config.LoRaConfig.RegionCode.my433
case .my_919:
return Config.LoRaConfig.RegionCode.my919
case .sg_923:
return Config.LoRaConfig.RegionCode.sg923
}
}
}
enum ModemPresets: Int, CaseIterable, Identifiable {
case longFast = 0
case longSlow = 1
case longModerate = 7
case vLongSlow = 2
case medSlow = 3
case medFast = 4
case shortSlow = 5
case shortFast = 6
var id: Int { self.rawValue }
var description: String {
switch self {
case .longFast:
return "Long Range - Fast"
case .longSlow:
return "Long Range - Slow"
case .longModerate:
return "Long Range - Moderate"
case .vLongSlow:
return "Very Long Range - Slow"
case .medSlow:
return "Medium Range - Slow"
case .medFast:
return "Medium Range - Fast"
case .shortSlow:
return "Short Range - Slow"
case .shortFast:
return "Short Range - Fast"
}
}
var name: String {
switch self {
case .longFast:
return "LongFast"
case .longSlow:
return "LongSlow"
case .longModerate:
return "LongModerate"
case .vLongSlow:
return "VLongFast"
case .medSlow:
return "MediumSlow"
case .medFast:
return "MediumFast"
case .shortSlow:
return "ShortSlow"
case .shortFast:
return "ShortFast"
}
}
func snrLimit() -> Float {
switch self {
case .longFast:
return -17.5
case .longSlow:
return -7.5
case .longModerate:
return -17.5
case .vLongSlow:
return -20
case .medSlow:
return -15
case .medFast:
return -12.5
case .shortSlow:
return -10
case .shortFast:
return -7.5
}
}
func protoEnumValue() -> Config.LoRaConfig.ModemPreset {
switch self {
case .longFast:
return Config.LoRaConfig.ModemPreset.longFast
case .longSlow:
return Config.LoRaConfig.ModemPreset.longSlow
case .longModerate:
return Config.LoRaConfig.ModemPreset.longModerate
case .vLongSlow:
return Config.LoRaConfig.ModemPreset.veryLongSlow
case .medSlow:
return Config.LoRaConfig.ModemPreset.mediumSlow
case .medFast:
return Config.LoRaConfig.ModemPreset.mediumFast
case .shortSlow:
return Config.LoRaConfig.ModemPreset.shortSlow
case .shortFast:
return Config.LoRaConfig.ModemPreset.shortFast
}
}
}
enum Bandwidths: Int, CaseIterable, Identifiable {
case thirtyOne = 31
case sixtyTwo = 62
case oneHundredTwentyFive = 125
case twoHundredFifty = 250
case fiveHundred = 500
var id: Int { self.rawValue }
var description: String {
switch self {
case .thirtyOne:
return "31 kHz"
case .sixtyTwo:
return "62 kHz"
case .oneHundredTwentyFive:
return "125 kHz"
case .twoHundredFifty:
return "250 kHz"
case .fiveHundred:
return "500 kHz"
}
}
}